Avez-vous une question? (216) 97 656 803 hajjriadh@gmail.com
Laravel

Les scripts npm et npx

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îne...

0 chapitres 0 QCM Accès gratuit
Dans cet article

À 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.
  1. Objectifs

    • Définir et lancer des scripts npm pour automatiser les tâches d'un projet.
    • Utiliser les scripts spéciaux (start, test), les crochets pre et post, 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.
  2. 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é scripts de package.json donne 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.
  3. Définir et lancer des scripts

    • Exemple de package.json d'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"
      }
    }
  4. 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 :
  5. 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
  6. npm run sans nom de script liste tous les scripts disponibles.
  7. Si le script n'existe pas, npm s'arrête avec npm error Missing script: "inconnu".
  8. Les scripts spéciaux et les crochets pre / post

    1. start, test et les raccourcis
      • Quelques noms se lancent sans run: npm start, npm test (ou npm t), npm stop, npm restart. Tous les autres exigent npm run.
      • Par convention :
        • start lance l'application en production ;
        • dev la lance en développement, avec redémarrage automatique (node --watch, intégré à Node.js, ou nodemon) ;
        • test lance les tests ; ici le lanceur de tests intégré node --test, qui cherche les fichiers *.test.js.
    2. Les crochets pre et post
      • Un script nommé preXXX s'exécute automatiquement avant XXX, et postXXX après. Dans l'exemple, npm run build enchaîne prebuild, build puis postbuild.
      • Si l'une des étapes échoue, la suite n'est pas exécutée.
    3. 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.
  9. Passer des arguments à un script

    • Tout ce qui suit -- est transmis à la commande du script. Avec le fichier saluer.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' ]
  10. Sans le --, npm considérerait --majuscules comme une de ses propres options et ne le transmettrait pas au script.
  11. process.argv contient le chemin de node, 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.
  12. Les outils locaux dans les scripts

    • Quand un paquet fournit une commande (nodemon, eslint, prettier…), npm la place dans le dossier node_modules/.bin du 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"
    }
  13. Ces outils sont installés en devDependencies du projet, avec une version fixée par le lock : chaque développeur utilise la même version, sans rien installer globalement.
  14. 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, comme construire.js, ou on utilise les options de Node.js comme node --env-file=.env pour les variables d'environnement.
  15. Exécuter un outil avec npx

    • npx est 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.
    npx -y cowsay "Bonjour Node"
     ______________
    < Bonjour Node >
     --------------
            \   ^__^
             \  (oo)\_______
                (__)\       )\/\
                    ||----w |
                    ||     ||
  16. L'option -y évite la question de confirmation avant le téléchargement.
  17. npx est idéal pour les générateurs qu'on lance une seule fois par projet, toujours dans leur dernière version :
  18. 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
  19. Prudence: npx exécute le code téléchargé sur votre ordinateur. Vérifiez l'orthographe du nom du paquet avant de valider.
  20. Activité 1 : les scripts d'une API

    • Pour un projet dont le point d'entrée est src/serveur.js, écrivez la propriété scripts qui permet :
      1. de démarrer en production avec npm start;
      2. de démarrer en développement avec relance automatique, en chargeant les variables du fichier .env;
      3. de lancer les tests avec npm test;
      4. d'afficher « Tests terminés » après chaque série de tests ;
      5. de lancer les tests, puis, s'ils réussissent, de démarrer l'application, avec npm run tout.
    • 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"
      }

      posttest s'exécute automatiquement après test. Dans tout, && empêche le démarrage si un test échoue.

  21. Activité 2 : un script avec arguments

    • Écrivez calcul.js, qui affiche la somme des nombres passés en arguments, et un script somme pour le lancer. Testez avec npm 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
  22. À retenir

    • Les scripts de package.json donnent des noms courts aux commandes du projet ; on les lance avec npm run nom.
    • start et test se lancent sans run; preXXX et postXXX s'exécutent avant et après XXX.
    • Les arguments se passent après -- et se lisent dans process.argv.slice(2).
    • Les scripts trouvent les outils installés localement (node_modules/.bin), sans installation globale.
    • npx exécute un outil, installé dans le projet ou téléchargé à la demande.
  23. Testez-vous

    • 1. Pourquoi npm dev ne fonctionne-t-il pas, alors que npm start fonctionne ?
    • 2. Dans quel ordre s'exécutent build, prebuild et postbuild après npm run build?
    • 3. Que se passe-t-il si on oublie le -- dans npm run saluer -- --majuscules?
    • 4. Quelle commande permet de créer un projet NestJS sans installer sa CLI globalement ?
    • Voir les réponses
      1. start fait partie des scripts qui ont un raccourci ; les autres, comme dev, s'appellent avec npm run dev.
      2. prebuild, puis build, puis postbuild.
      3. npm prend --majuscules pour une de ses options et ne le transmet pas au script.
      4. npx @nestjs/cli new mon-api.

Cet article vous a-t-il aidé ?