Formation Apprendre le JavaScript : Utiliser npm

Dans ce nouveau chapitre nous allons découvrir npm et comment on peut utiliser des librairies tiers dans notre projet

Les scripts

Afin de simplifier le démarrage de votre projet et d'éviter à avoir à retaper les même commandes à chaque fois, vous pouvez utiliser la partie script de votre fichier package.json.

{
  "scripts": {
    "dev": "node watcher.js app.js",
    "start": "node app.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  }
}

Les scripts enregistrés de cette manière là pourront ensuite être lancé à l'aide de la commande npm suivi du nom du script.

npm run dev

Les dépendances

NodeJS dispose d'une très grosse communauté et de nombreuses librairies open source existe pour vous permettre de simplifier certaines tâche. La première étape est de recherche un paquet en vous rendant sur npmjs.com. Une fois le package trouvé vous pourrez l'installer dans votre projet à l'aide de la commande npm install.

npm i <nom_paquet>

Le paquet va être téléchargé et placé dans un dossier node_modules à la racine de votre projet. Ce dossier contiendra votre dépendance et l'ensemble de ces sous-dépendance si il y en a. Vous pourrez ensuite importer la librairie dans votre projet avec la syntaxe EcmaScript.

import chalk from 'chalk'

console.log(chalk.blue('Je suis bleu !'))

Votre fichier package.json sera aussi modifié pour inclure la dépendance dans la clef dependencies.

  "dependencies": {
    "fastify": "^4.8.1"
  },

Si une personne récupère votre projet, elle pourra installer les dépendance automatiquement à l'aide de la commande npm install et dans ce cas là les dépendance inscrite dans le fichier package.json seront utilisé pour télécharger les dépendances spécifiques au projet.

Éxécutable

Il est aussi possible d'importer des modules qui offrent des éxécutables que vous pouvez utiliser pour effectuer certaines opérations. nodemon permettra par exemple de relancer vos script automatiquement en cas de modification.

npm i nodemon

Lors de son installation un éxécutable sera placé dans le dossier node_modules/.bin et vous pourrez l'éxécuter en utilisant la commande npx qui sera capable de trouver les éxécutable dans le dossier .bin.

npx nodemon app.js

Vous pouvez aussi ajouter cet éxécutable dans les scripts de votre fichier package.json (dans ce cas là npx ne sera pas nécessaire).

{
  "scripts": {
    "dev": "nodemon app.js",
    "start": "node app.js",
    "test": "echo \"Error: no test specified\" && exit 1"
  }
}