Nodemon é um utilitário de interface de linha de comando que auxilia na criação de aplicativos Node.js reiniciando dinamicamente o aplicativo de nó quando ele identifica alterações de arquivo no diretório.
Este artigo ensinará como instalar e configurar o nodemon para atender às suas necessidades específicas, além de explorar um erro comum que ocorre ao usar o nodemon
Por que você deve usar Nodemon
Ao desenvolver servidores da Web ou aplicativos de back-end, você deve alterar seu código para lidar com erros e melhorar a estrutura e a lógica do seu programa.
O Nodemon auxilia reiniciando automaticamente um servidor quando você faz alterações em seu código. Isso ajuda a economizar tempo e permite uma depuração mais fácil.
Como instalar Nodemon
Você pode instalar o Nodemon localmente como uma dependência de desenvolvimento ou globalmente no caminho do sistema.
Para instalar o nodemon globalmente, execute o seguinte comando npm no terminal do seu computador:
npm install nodemon --globalmente
Para instalar o nodemon localmente, você deve executar o seguinte comando npm dentro do diretório do seu projeto no seu terminal:
npm install nodemon --save-dev
Iniciando o Nodemon em seu aplicativo de servidor Web
Iniciar o nodemon e fazer com que ele monitore seu aplicativo de servidor da web envolve algumas etapas. O bloco de código abaixo é um script básico para um servidor que registra uma mensagem de string no console:
// app.js
const expresso = exigir('expressar');
const aplicativo = expresso();
app.listen((5000), ()=>{
console.registro(`Estou aprendendo sobre nodemon`)
});
Para começar a assistir este script, execute o comando nodemon seguido do nome do arquivo que ele deve assistir:
nodemon app.js
A saída resultante deve incluir algo como o seguinte texto:
[nodemon] iniciando `node app.js`
estou aprendendo sobre nodemon
Depois que o nodemon for iniciado com sucesso, quaisquer alterações no app.js arquivo causará um recarregamento em todo o aplicativo do servidor.
Você pode sair do nodemon pressionando Ctrl + C no terminal do seu computador. Você também pode reiniciar o processo do nodemon manualmente inserindo o rs comando.
Usando o Nodemon com opções de linha de comando
O Nodemon tem várias opções de linha de comando que você pode usar para modificar seu comportamento.
Para ver uma lista de todas as opções de nodemon disponíveis e suas funções, execute este comando:
nodemon --opções de ajuda
Entre as muitas opções disponíveis estão;
-
--atraso: Quando um arquivo é alterado, o nodemon espera um segundo por padrão antes de reiniciar o processo. Você pode especificar um atraso diferente com --atraso trocar. Você pode selecionar a quantidade de tempo que o nodemon esperará antes de reiniciar. Por exemplo:
nodemon --delay five app.js
-
--ignorar: A opção ignorar switch permite que você ignore arquivos específicos em seu aplicativo de servidor web. Você pode usar a opção switch assim:
nodemon --ignore lib/app.js
-
--assistir: Por padrão, durante a execução, o nodemon monitora o diretório de trabalho atual. Para assumir o controle dessa opção, use o --assistir opção para adicionar caminhos de arquivo específicos e alterar qual diretório está sendo observado. Por exemplo, monitorando um diretório de servidor:
nodemon --watch server
-
--exec: embora seja um utilitário JavaScript, você também pode usar o Nodemon para assistir a arquivos não JavaScript, como TypeScript, Python e Golang. Você pode usar o --executivo opção para obter a função de recarregamento automático do nodemon em tais scripts. Por exemplo, usando nodemon em um script TypeScript:
nodemon --exec ts-node
-
--ext: Nodemon, por padrão, procura arquivos com extensões JavaScript, TypeScript, CoffeeScript e JSON. Isto é porque Projetos Node.js podem funcionar com TypeScript e arquivos CoffeeScript que compilam em JavaScript puro antes de serem executados. Por outro lado, os arquivos JSON também são monitorados porque costumam ser usados para armazenar metadados para projetos Node.js. Você pode usar o -e (ou --ramal) alterne para especificar uma lista separada por vírgulas de arquivos a serem observados. Por exemplo, para monitorar arquivos com extensões .js, .json, e .mjs:
nodemon --ext js, json, mjs
Usando arquivos de configuração do Nodemon
Nodemon suporta arquivos de configuração locais e globais. Você pode encontrá-los em seu diretório pessoal ou no diretório raiz do projeto; eles são normalmente chamados nodemon.json arquivos. Dessa forma, você pode salvar suas configurações de nodemon e reutilizá-las facilmente em outros projetos.
As opções da linha de comando sempre substituirão as configurações do arquivo de configuração. A ordem de prioridade de trabalho inclui opções de linha de comando, arquivos locais e de configuração.
Um arquivo de configuração pode usar qualquer opção de linha de comando como um valor de chave JSON.
Por exemplo:
{
"assistir": [ "servidor" ],
"ext": [ "js", "ts", "json" ],
"atraso": "5000",
"ignorar": [ "lib/app.js" ]
}
No acima nodemon.json arquivo, o nodemon está configurado para assistir o servidor diretório, especifique arquivos com .js, .ts, e .json extensões, atraso para 5 segundos antes de reiniciar após as alterações de arquivo e, finalmente, ignorar as alterações de arquivo em lib/app.js.
Como alternativa, o nodemon suporta o uso pacote.json para configuração se você mantiver todas as configurações de pacote em um único local. Sob nodemonConfig no arquivo package.json, especifique a configuração no mesmo formato que você faria para um arquivo de configuração.
Por exemplo, este arquivo package.json inclui a mesma configuração do arquivo nodemon.json acima:
{
"nome": "nodemônio",
"versão": "",
"descrição": "",
"nodemonConfig": {
"assistir": [
"servidor"
],
"ext": [ "js", "ts", "json" ],
"atraso": "5",
"ignorar": [
"lib/app.js"
]
}
}
Manipulando Erros do Nodemon
Enquanto estiver desenvolvendo seu aplicativo, você precisará lidar com erros em JavaScript ao longo do caminho. Para lidar com esses erros, primeiro você precisa saber por que eles acontecem.
Aqui está um erro comum que você pode encontrar ao trabalhar com nodemon:
O aplicativo [nodemon] travou - aguardando alterações no arquivo antes de iniciar...
Existem vários motivos pelos quais essa mensagem de erro pode ocorrer e várias maneiras de corrigir as causas.
- Sintaxe de JavaScript incorreta nos arquivos que o nodemon está monitorando. Para evitar esse erro, analise seu código JavaScript para identificar quaisquer erros de sintaxe nele.
- A execução de várias tarefas em segundo plano pode interferir nessa tarefa específica. Tente interromper todos os processos em segundo plano e executar o programa novamente para corrigir isso.
- A organização incorreta do diretório também pode causar problemas. Por exemplo, não ter os arquivos app.js e package.json no mesmo diretório. Certifique-se de estruturar seu diretório adequadamente para que não afete a execução de seus programas.
Ficando confortável com o Nodemon
Você viu a utilidade do nodemon e como ele pode criar um fluxo de trabalho melhor, reduzir erros e tornar a depuração mais rápida e fácil.
No entanto, ainda podem ocorrer erros ao trabalhar com nodemon. Como desenvolvedor, aprender como solucionar esses erros é importante.