Des lecteurs comme vous aident à soutenir MUO. Lorsque vous effectuez un achat en utilisant des liens sur notre site, nous pouvons gagner une commission d'affiliation. En savoir plus.

Nodemon est un utilitaire d'interface de ligne de commande qui aide à créer des applications Node.js en redémarrant dynamiquement l'application de nœud lorsqu'il identifie les modifications de fichier dans le répertoire.

Cet article vous apprendra comment installer et configurer nodemon en fonction de vos besoins particuliers, ainsi qu'explorer une erreur courante qui se produit lors de l'utilisation de nodemon

Pourquoi devriez-vous utiliser Nodemon

Lors du développement de serveurs Web ou d'applications backend, vous êtes obligé de modifier votre code pour gérer les erreurs et améliorer la structure et la logique de votre programme.

Nodemon assiste en redémarrant automatiquement un serveur lorsque vous apportez des modifications à son code. Cela permet de gagner du temps et facilite le débogage.

Comment installer Nodemon

instagram viewer

Vous pouvez installer Nodemon soit localement en tant que dépendance de développement, soit globalement sur le chemin du système.

Pour installer nodemon globalement, exécutez la commande npm suivante dans le terminal de votre ordinateur :

npm installer nodemon --globalement

Pour installer nodemon localement, vous devez exécuter la commande npm suivante dans votre répertoire de projet dans votre terminal :

npm installer nodemon --save-dev

Démarrage de Nodemon dans votre application de serveur Web

Démarrer nodemon et le faire surveiller votre application de serveur Web implique quelques étapes. Le bloc de code ci-dessous est un script de base pour un serveur qui enregistre un message de chaîne dans la console :

// app.js
constante exprimer = exiger('exprimer');
constante app = express();
app.listen((5000), ()=>{
console.enregistrer(`J'apprends à propos de nodemon`)
});

Pour commencer à regarder ce script, exécutez la commande nodemon suivie du nom du fichier qu'il doit surveiller :

nodemon app.js

La sortie résultante doit inclure quelque chose comme le texte suivant :

[nodemon] démarrage de `node app.js`
J'apprends Nodemon

Une fois que nodemon a démarré avec succès, toute modification apportée au app.js entraînera un rechargement de l'ensemble de l'application serveur.

Vous pouvez quitter nodemon en appuyant sur Ctrl + C dans le terminal de votre ordinateur. Vous pouvez également redémarrer le processus nodemon manuellement en saisissant le rs commande.

Utilisation de Nodemon avec les options de ligne de commande

Nodemon dispose de plusieurs options de ligne de commande que vous pouvez utiliser pour modifier son comportement.

Pour voir une liste de toutes les options nodemon disponibles et de leurs fonctions, exécutez cette commande :

nodemon --options d'aide

Parmi les nombreuses options disponibles sont;

  • --retard: Lorsqu'un fichier change, nodemon attend une seconde par défaut avant de redémarrer le processus. Vous pouvez spécifier un délai différent avec le --retard changer. Vous pouvez sélectionner la durée d'attente de nodemon avant de redémarrer. Par exemple: 
    nodemon --delay cinq app.js
  • --ignorer: L'option de commutateur Ignorer vous permet d'ignorer des fichiers spécifiques dans votre application de serveur Web. Vous pouvez utiliser l'option switch comme ceci: 
    nodemon --ignore lib/app.js
  • --montre: Par défaut, lors de l'exécution, nodemon surveille le répertoire de travail actuel. Pour prendre le contrôle de cette option, utilisez le --montre option pour ajouter des chemins de fichiers spécifiques et changer le répertoire surveillé. Par exemple, surveiller un répertoire de serveur: 
    serveur nodemon --watch
  • --exec: bien qu'il s'agisse d'un utilitaire JavaScript, vous pouvez également utiliser Nodemon pour regarder des fichiers non JavaScript tels que TypeScript, Python et Golang. Vous pouvez utiliser le --exec option pour obtenir la fonction de rechargement automatique de nodemon dans de tels scripts. Par exemple, en utilisant nodemon dans un script TypeScript: 
    nodemon --exec ts-node
  • --ext: Nodemon, par défaut, recherche les fichiers avec les extensions JavaScript, TypeScript, CoffeeScript et JSON. Ceci est dû au fait Les projets Node.js peuvent fonctionner avec TypeScript et des fichiers CoffeeScript qui se compilent en JavaScript pur avant d'être exécutés. D'autre part, les fichiers JSON sont également surveillés car ils sont souvent utilisés pour stocker des métadonnées pour les projets Node.js. Vous pouvez utiliser le -e (ou --poste) pour spécifier une liste de fichiers séparés par des virgules à surveiller. Par exemple, pour surveiller les fichiers avec des extensions .js, .json, et .mjs: 
    nodemon --ext js, json, mjs

Utilisation des fichiers de configuration Nodemon

Nodemon prend en charge les fichiers de configuration locaux et globaux. Vous pouvez les trouver dans votre répertoire personnel ou dans le répertoire racine du projet; ils sont généralement appelés nodemon.json des dossiers. De cette façon, vous pouvez enregistrer vos configurations nodemon et les réutiliser facilement avec d'autres projets.

Les options de la ligne de commande remplaceront toujours les paramètres du fichier de configuration. L'ordre de priorité de travail comprend les options de ligne de commande, les fichiers locaux et de configuration.

Un fichier de configuration peut utiliser n'importe quelle option de ligne de commande comme valeur de clé JSON.

Par exemple:

{
"montre": [ "serveur" ],
"poste": [ "js", "ts", "json" ],
"retard": "5000",
"ignorer": [ "lib/app.js" ]
}

Au dessus nodemon.json fichier, nodemon est configuré pour surveiller le serveur répertoire, spécifiez les fichiers avec .js, .ts, et .json prolongations, délai pour 5 secondes avant de redémarrer après les modifications de fichier, et enfin ignorer les modifications de fichier dans lib/app.js.

Comme alternative, nodemon prend en charge l'utilisation package.json pour la configuration si vous conservez toutes les configurations de package au même endroit. Sous nodemonConfig dans le fichier package.json, spécifiez la configuration dans le même format que vous le feriez pour un fichier de configuration.

Par exemple, ce fichier package.json inclut la même configuration que le fichier nodemon.json ci-dessus :

{
"nom": "nodémon",
"version": "",
"description": "",
"nodemonConfig": {
"montre": [
"serveur"
 ],
"poste": [ "js", "ts", "json" ],
"retard": "5",
"ignorer": [
"lib/app.js"
 ]
 }
}

Gestion des erreurs Nodemon

Pendant que vous développez votre application, vous devrez gérer les erreurs dans JavaScript le long du chemin. Pour gérer ces erreurs, vous devez d'abord savoir pourquoi elles se produisent.

Voici une erreur courante que vous pouvez rencontrer lorsque vous travaillez avec nodemon :

L'application [nodemon] s'est écrasée - en attente de modifications de fichiers avant de démarrer...

Il existe plusieurs raisons pour lesquelles ce message d'erreur peut se produire et plusieurs façons de résoudre les causes.

  • Mauvaise syntaxe JavaScript dans les fichiers que nodemon surveille. Pour éviter cette erreur, parcourez votre code JavaScript pour identifier toute erreur de syntaxe qu'il contient.
  • L'exécution de plusieurs tâches en arrière-plan peut interférer avec cette tâche particulière. Essayez d'arrêter tous les processus d'arrière-plan et d'exécuter à nouveau le programme pour résoudre ce problème.
  • Une organisation incorrecte des répertoires peut également causer des problèmes. Par exemple, ne pas avoir les fichiers app.js et package.json dans le même répertoire. Assurez-vous de bien structurer votre répertoire afin qu'il n'affecte pas le fonctionnement de vos programmes.

Être à l'aise avec Nodemon

Vous avez vu l'utilité de nodemon et comment il peut créer un meilleur flux de travail, réduire les erreurs et rendre le débogage plus rapide et plus facile.

Cependant, des erreurs peuvent toujours se produire lorsque vous travaillez avec nodemon. En tant que développeur, il est important d'apprendre à résoudre ces erreurs.