Le gestionnaire de paquets npm (package.json, dépendances, scripts)

npm, le gestionnaire de paquets

npm (Node Package Manager) est installé avec Node.js. Il donne accès au registre npm (npmjs.com), qui contient des centaines de milliers de paquets (bibliothèques) réutilisables. NestJS lui-même est distribué sous forme de paquets npm : @nestjs/core, @nestjs/common…

D'autres gestionnaires compatibles existent (pnpm, yarn) ; la CLI Nest vous proposera de choisir. Dans ce cours, nous utilisons npm.

Créer un projet : npm init

mkdir api-stagiaires
cd api-stagiaires
npm init -y        # crée package.json avec les valeurs par défaut

Le fichier package.json

C'est la carte d'identité du projet : nom, version, scripts et liste des dépendances.

Les quatre parties essentielles d'un package.json.

Installer des dépendances

dependencies: nécessaires au fonctionnement de l'application (par exemple @nestjs/core, typeorm). devDependencies: utiles uniquement pour développer (TypeScript, Jest, ESLint, la CLI Nest locale).

Les numéros de version

npm utilise le versionnage sémantique MAJEUR.MINEUR.CORRECTIF:

• CORRECTIF (1.4.2) : corrections de bugs.
• MINEUR (1.5. 0) : nouvelles fonctions, compatibles.
• MAJEUR (2. 0.0) : changements incompatibles.

node_modules et package-lock.json

• node_modules/ contient le code de tous les paquets installés (et de leurs propres dépendances). Ce dossier est très volumineux : on ne le copie jamais et on ne le met jamais sur GitHub. Un simple npm install le recrée.
• package-lock.json enregistre la version exacte de chaque paquet installé. Il doit être versionné : toute l'équipe et le serveur installeront ainsi exactement les mêmes versions.

# .gitignore
node_modules/
dist/
.env

Les scripts npm

La section scripts donne des raccourcis pour les commandes du projet. On les lance avec npm run nom (npm start et npm test fonctionnent sans run).

"scripts": {
  "start": "node index.js",
  "dev": "node --watch index.js",
  "test": "jest"
}

Un projet NestJS est livré avec des scripts prêts à l'emploi : npm run start:dev, npm run build, npm run test, npm run lint… Vous les découvrirez à la leçon 2.4.

npx : exécuter sans installer

npx exécute la commande d'un paquet sans l'installer globalement. Par exemple, npx @nestjs/cli new mon-api crée un projet NestJS même si la CLI n'est pas installée.

Activités

npm i express
npm i -D nodemon

const express = require('express');
const app = express();
app.get('/', (req, res) => res.json({ message: 'API stagiaires' }));
app.listen(3000, () => console.log('http://localhost:3000'));