À propos de ce cours
Cette leçon montre comment automatiser les tâches d'un projet Node.js avec la propriété scripts de package.json : lancer un script avec npm run, utiliser les raccourcis npm start et npm test, enchaîner des étapes avec les crochets pre et post et avec &&, et transmettre des arguments après -- en les lisant dans process.argv. Elle explique pourquoi les scripts trouvent les outils installés localement dans node_modules/.bin, comment écrire des scripts qui fonctionnent sous Windows comme sous Linux, puis comment exécuter un outil sans l'installer avec npx (générateurs NestJS, Angular, Express). Deux activités corrigées et un quiz complètent la leçon.
Objectifs
- Définir et lancer des scripts npm pour automatiser les tâches d'un projet.
- Utiliser les scripts spéciaux (
start,test), les crochetspreetpost, et passer des arguments à un script. - Comprendre pourquoi un script trouve les outils installés localement.
- Exécuter un outil sans l'installer avec
npx.
Pourquoi des scripts npm ?
- Un projet demande souvent les mêmes commandes : démarrer le serveur, le relancer à chaque modification, lancer les tests, construire la version de production… Les écrire à la main est long et chacun finit par les taper différemment.
- La propriété
scriptsdepackage.jsondonne un nom court à chaque commande. Toute l'équipe utilise les mêmes noms, quel que soit le système :npm run dev,npm test,npm run build. - C'est aussi la documentation du projet : en ouvrant
package.json, un nouveau développeur sait immédiatement comment le lancer.
Définir et lancer des scripts
- Exemple de
package.jsond'une boutique :
{ "name": "boutique", "version": "1.0.0", "type": "module", "scripts": { "start": "node app.js", "dev": "node --watch app.js", "test": "node --test", "prebuild": "echo Nettoyage avant la construction", "build": "node construire.js", "postbuild": "echo Construction terminée", "saluer": "node saluer.js", "verifier": "npm run test && npm run build" } }- Exemple de
- Chaque script se lance avec
npm run nom. Avant d'exécuter la commande, npm affiche le nom du paquet, le script et la commande réellement lancée : npm runsans nom de script liste tous les scripts disponibles.- Si le script n'existe pas, npm s'arrête avec
npm error Missing script: "inconnu". Les scripts spéciaux et les crochets pre / post
start, test et les raccourcis
- Quelques noms se lancent sans
run:npm start,npm test(ounpm t),npm stop,npm restart. Tous les autres exigentnpm run. - Par convention :
startlance l'application en production ;devla lance en développement, avec redémarrage automatique (node --watch, intégré à Node.js, ounodemon) ;testlance les tests ; ici le lanceur de tests intégrénode --test, qui cherche les fichiers*.test.js.
- Quelques noms se lancent sans
Les crochets pre et post
- Un script nommé
preXXXs'exécute automatiquement avantXXX, etpostXXXaprès. Dans l'exemple,npm run buildenchaîneprebuild,buildpuispostbuild. - Si l'une des étapes échoue, la suite n'est pas exécutée.
- Un script nommé
Enchaîner des scripts
- Un script peut appeler d'autres scripts. Avec
&&, la deuxième commande ne s'exécute que si la première réussit :"verifier": "npm run test && npm run build"ne construit le projet que si tous les tests passent.
- Un script peut appeler d'autres scripts. Avec
Passer des arguments à un script
- Tout ce qui suit
--est transmis à la commande du script. Avec le fichiersaluer.js:
console.log('Arguments reçus :', process.argv.slice(2));npm run saluer -- Sara --majuscules > boutique@1.0.0 saluer > node saluer.js Sara --majuscules Arguments reçus : [ 'Sara', '--majuscules' ]- Tout ce qui suit
- Sans le
--, npm considérerait--majusculescomme une de ses propres options et ne le transmettrait pas au script. process.argvcontient le chemin denode, celui du script, puis les arguments :slice(2)ne garde que ces derniers. Le TP 1 de ce chapitre s'en sert pour lire les commandes de l'utilisateur.Les outils locaux dans les scripts
- Quand un paquet fournit une commande (nodemon, eslint, prettier…), npm la place dans le dossier
node_modules/.bindu projet. - Pendant l'exécution d'un script, npm ajoute ce dossier au
PATH. On écrit donc simplement :
"scripts": { "dev": "nodemon src/index.js", "lint": "eslint src" }- Quand un paquet fournit une commande (nodemon, eslint, prettier…), npm la place dans le dossier
- Ces outils sont installés en
devDependenciesdu projet, avec une version fixée par le lock : chaque développeur utilise la même version, sans rien installer globalement. - Pour qu'un script fonctionne sous Windows comme sous Linux ou macOS, on évite les commandes propres à un système (
rm -rf,cp,export VAR=…). On écrit plutôt un petit fichier Node.js, commeconstruire.js, ou on utilise les options de Node.js commenode --env-file=.envpour les variables d'environnement. Exécuter un outil avec npx
npxest installé avec npm. Il exécute la commande d'un paquet :- si le paquet est installé dans le projet, il utilise celui de
node_modules/.bin:npx nodemon app.js; - sinon, il le télécharge dans un cache temporaire, l'exécute, puis le laisse dans le cache, sans rien ajouter au projet ni au système.
- si le paquet est installé dans le projet, il utilise celui de
npx -y cowsay "Bonjour Node" ______________ < Bonjour Node > -------------- \ ^__^ \ (oo)\_______ (__)\ )\/\ ||----w | || ||- L'option
-yévite la question de confirmation avant le téléchargement. - npx est idéal pour les générateurs qu'on lance une seule fois par projet, toujours dans leur dernière version :
- Prudence: npx exécute le code téléchargé sur votre ordinateur. Vérifiez l'orthographe du nom du paquet avant de valider.
Activité 1 : les scripts d'une API
- Pour un projet dont le point d'entrée est
src/serveur.js, écrivez la propriétéscriptsqui permet :- de démarrer en production avec
npm start; - de démarrer en développement avec relance automatique, en chargeant les variables du fichier
.env; - de lancer les tests avec
npm test; - d'afficher « Tests terminés » après chaque série de tests ;
- de lancer les tests, puis, s'ils réussissent, de démarrer l'application, avec
npm run tout.
- de démarrer en production avec
Voir le corrigé
"scripts": { "start": "node src/serveur.js", "dev": "node --watch --env-file=.env src/serveur.js", "test": "node --test", "posttest": "echo Tests terminés", "tout": "npm test && npm start" }posttests'exécute automatiquement aprèstest. Danstout,&&empêche le démarrage si un test échoue.- Pour un projet dont le point d'entrée est
Activité 2 : un script avec arguments
- Écrivez
calcul.js, qui affiche la somme des nombres passés en arguments, et un scriptsommepour le lancer. Testez avecnpm run somme -- 10 25 7.
Voir le corrigé
// calcul.js const nombres = process.argv.slice(2).map(Number); const total = nombres.reduce((somme, n) => somme + n, 0); console.log(`Somme de ${nombres.join(' + ')} = ${total}`);"scripts": { "somme": "node calcul.js" }npm run somme -- 10 25 7 Somme de 10 + 25 + 7 = 42- Écrivez
À retenir
- Les
scriptsdepackage.jsondonnent des noms courts aux commandes du projet ; on les lance avecnpm run nom. startettestse lancent sansrun;preXXXetpostXXXs'exécutent avant et aprèsXXX.- Les arguments se passent après
--et se lisent dansprocess.argv.slice(2). - Les scripts trouvent les outils installés localement (
node_modules/.bin), sans installation globale. npxexécute un outil, installé dans le projet ou téléchargé à la demande.
- Les
Testez-vous
- 1. Pourquoi
npm devne fonctionne-t-il pas, alors quenpm startfonctionne ? - 2. Dans quel ordre s'exécutent
build,prebuildetpostbuildaprèsnpm run build? - 3. Que se passe-t-il si on oublie le
--dansnpm run saluer -- --majuscules? - 4. Quelle commande permet de créer un projet NestJS sans installer sa CLI globalement ?
startfait partie des scripts qui ont un raccourci ; les autres, commedev, s'appellent avecnpm run dev.prebuild, puisbuild, puispostbuild.- npm prend
--majusculespour une de ses options et ne le transmet pas au script. npx @nestjs/cli new mon-api.
Voir les réponses
- 1. Pourquoi
npm run build
> boutique@1.0.0 prebuild
> echo Nettoyage avant la construction
Nettoyage avant la construction
> boutique@1.0.0 build
> node construire.js
Construction du projet…
> boutique@1.0.0 postbuild
> echo Construction terminée
Construction terminée
npx @nestjs/cli new mon-api # créer un projet NestJS
npx @angular/cli new mon-app # créer un projet Angular
npx express-generator mon-site # créer un squelette Express
npx npm-check-updates # lister les mises à jour majeures disponibles
Cet article vous a-t-il aidé ?
Merci pour votre avis sur cet article 🙏
Merci, votre message nous a bien été transmis 🙏
Cette leçon vous a été utile ? Partagez-la !