Configurer le fichier package.json

  • 4 minutes

Bienvenue dans le monde de la gestion de projet Node.js avec npm et la gestion de packages. Examinons en détail les éléments essentiels de l’empaquetage et la façon dont il peut booster votre processus de développement.

Empaquetage et gestion de packages

NPM, le gestionnaire de package par défaut pour Node.js, est votre arme secrète pour incorporer du code externe dans vos projets. C’est comme avoir un assistant personnel pour vous aider à créer des applications plus rapidement et plus efficacement.

L’empaquetage s’apparente à l’emballage de votre code dans du papier-cadeau en vue de sa distribution. Il regroupe proprement votre code et ses dépendances dans un package que d’autres personnes peuvent facilement installer et utiliser. La gestion de packages est l’art de gérer ces packages, et elle implique ce qui suit :

  • Le fichier package.json, blueprint de votre projet. Il contient des métadonnées sur votre projet, et prend en charge la gestion des dépendances et des fichiers de package.
  • L’outil CLI npm, votre assistant personnel pour l’installation et la gestion des packages à partir du registre npm.
  • Le registre npm, un trésor de packages publics immédiatement utilisables dans vos projets.

Créer votre fichier package.json

Pour créer un fichier package.json, il suffit d’exécuter une commande npm init. Il existe deux manières de procéder :

  • npm init : cette commande est semblable à un guide convivial, vous menant à travers un processus pas à pas qui vous invite à fournir des détails sur votre projet, comme son nom, sa version et sa description.
  • npm init -y : cette commande est la version express de npm init. Elle compresse les questions et renseigne les valeurs par défaut pour vous.

Voici un aperçu du fichier package.json que vous allez générer.

{
  "name": "my project",
  "version": "1.0.0",
  "description": "",
  "main": "script.js",
  "dependencies": {},
  "devDependencies": {},
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

Comprendre les zones du fichier package.json

Pensez au fichier package.json comme à un coffre à trésor, rempli de pierres précieuses qui donnent à votre projet tout son éclat. Ces pierres précieuses sont les propriétés du fichier package.json, et elles appartiennent à trois catégories principales :

  • Méta-informations : ces propriétés sont comme les joyaux de la couronne ; elles définissent les méta-informations relatives à votre projet. Elles incluent le nom du projet, la description, l’auteur, les mots clés, et ainsi de suite.
  • Dépendances : il s’agit des pièces d’or et d’argent, qui représentent les packages utilisés par votre projet. Les propriétés dependencies et devDependencies renferment ces trésors. Au fur et à mesure de notre parcours, vous découvrirez comment utiliser ces propriétés pour installer, mettre à jour et gérer vos dépendances.
  • Scripts : il s’agit des commandes de terminal qui entraînent l’exécution des tâches de votre projet. Vous pouvez répertorier des scripts pour des tâches telles que le démarrage, la génération, le test et le lint.

Accélérer les tâches avec des scripts

Dans votre fichier package.json, vous devez inclure au moins quatre scripts courants :

  • start : ce script donne vie à votre projet. Par exemple, il peut utiliser la commande node ./src/index.js.
  • build : ce script prépare votre projet pour ses grands débuts. Il peut par exemple transformer TypeScript en JavaScript.
  • test : ce script vérifie l’intégrité de votre projet, généralement à l’aide d’un package de test.
  • lint : ce script nettoie votre code, et vérifie la présence éventuelle de problèmes de style et de mise en forme à l’aide d’un outil tel que ESLint.

Ces noms de script sont comme des mots magiques, reconnus universellement par toute la communauté des développeurs, et essentiels à la bonne organisation de votre projet.

Normaliser les noms des scripts

Dans votre fichier package.json, les scripts sont définis avec une action et une commande :

"scripts" : {
  "<action>" : "<command>"
}

Voici un exemple :

"scripts" : {
  "start" : "node ./dist/index.js",
  "test": "jest",
  "build": "tsc",
  "lint": "eslint"
}

Exécuter un script

Pour exécuter un script dans un terminal en entrant la commande npm run <action>. Par exemple : npm run lint.

Les actions start et test sont spéciales en ce sens que vous pouvez omettre le mot run dans la commande. Au lieu d’entrer la commande npm run start, vous pouvez entrer npm start.

Utiliser un environnement de développement prédéfini

Ce module de formation offre un conteneur de développement, soit dans un navigateur, soit pour votre ordinateur local. Ce conteneur fournit tout l’environnement nécessaire afin de pouvoir utiliser ce module de formation sans avoir à installer un IDE ou Node.js. Vous n’avez pas besoin de savoir quoi que ce soit sur le conteneur pour effectuer ce module de formation.