Exercice – Configurer le fichier package.json

Effectué

Vous êtes développeur Node.js chez Tailwind Traders. Savoir comment configurer un nouveau projet Node.js est une compétence importante. La configuration comprend la génération d’un fichier package.json et la création de scripts courants à utiliser tout au long du cycle de vie du projet.

Ouvrir le projet dans le conteneur de développement

Un environnement de développement simple vous est fourni. Si Node.js LTS est déjà installé sur votre ordinateur, vous pouvez ignorer cette section, cloner l’exemple de référentiel et utiliser votre environnement local.

Développement à distance (navigateur)

1. Démarrez le processus pour créez un environnement GitHub Codespace sur la branche main du référentiel GitHub MicrosoftDocs/node-essentials.

   Ouvrir ce projet dans GitHub Codespaces

2. Dans la page Créer un codespace , passez en revue les paramètres de configuration du codespace, puis sélectionnez Créer un codespace

   

3. Attendez que le codespace démarre. Ce processus de démarrage peut prendre quelques minutes.

4. Ouvrez un nouveau terminal dans le codespace.

   Conseil

   Vous pouvez utiliser le menu principal pour accéder à l’option de menu Terminal, puis sélectionner l’option Nouveau terminal.

   

5. Vérifiez que Node.js 7 est installé dans votre environnement :

   node --version
   

   Le conteneur de développement utilise une version Node.js LTS telle que v20.5.1. La version exacte peut être différente.

6. Les exercices restants de ce projet ont lieu dans le contexte de ce conteneur de développement.

Développement local (Docker)

1. Ouvrez Visual Studio Code dans le contexte d’un répertoire vide.

2. Vérifiez que l’extension Dev Containers est installée dans Visual Studio Code.

3. Ouvrez un nouveau terminal dans l’éditeur.

   Conseil

   Vous pouvez utiliser le menu principal pour accéder à l’option de menu Terminal, puis sélectionner l’option Nouveau terminal.

   

4. Clonez le MicrosoftDocs/node-essentials dépôt GitHub dans le répertoire actif.

   git clone https://github.com/MicrosoftDocs/node-essentials.git
   

5. Ouvrez le référentiel dans le code avec les commandes suivantes dans le terminal.

   cd node-essentials
   code .
   

6. Ouvrez la palette de commandes, recherchez les commandes Conteneurs de développement, puis sélectionnez Conteneurs de développement : rouvrir dans conteneur.

   Conseil

   Visual Studio Code peut vous inviter automatiquement à rouvrir le dossier existant dans un conteneur de développement. Cela équivaut fonctionnellement à utiliser la palette de commandes pour rouvrir l’espace de travail actif dans un conteneur.

   

7. Vérifiez que Node.js 7 est installé dans votre environnement :

   node --version
   

   Le conteneur de développement utilise une version Node.js LTS telle que v20.5.1. La version exacte peut être différente.

8. Les exercices restants de ce projet ont lieu dans le contexte de ce conteneur de développement.

Configuration d’un nouveau projet Node.js

Le code source JavaScript vous a été fourni pour cette unité. Votre tâche consiste à créer le fichier package.json.

1. Dans le terminal, accédez au dossier pour cet exercice :

   cd node-dependencies/3-exercise-package-json
   

2. Affichez le contenu du dossier :

   ls -R
   

   Dans ce dossier, vous devez voir un sous-dossier nommé src qui contient un fichier index.js :

    ./src:
        index.js
   

3. Exécutez la commande suivante pour créer le fichier package.json avec les valeurs par défaut suivantes :

   npm init -y
   

   Le fichier package.json qui ressemble à cet exemple :

   {
     "name": "3-exercise-package-json",
     "version": "1.0.0",
     "description": "",
     "main": "index.js",
     "scripts": {
       "test": "echo \"Error: no test specified\" && exit 1"
     },
     "keywords": [],
     "author": "",
     "license": "ISC"
   }
   

4. Modifiez le package.json avec les valeurs de propriété suivantes :

   • name : "tailwind-trader-api"
   • description : "API HTTP pour gérer les éléments de la base de données Tailwind Traders"
   • main : "index.js"
   • keywords : ["API", "database"]
   • author : "Sam"

   Votre fichier package.json doit maintenant ressembler à ce code :

   {
     "name": "tailwind-trader-api",
     "version": "1.0.0",
     "description": "HTTP API to manage items from the Tailwind Traders database",
     "main": "index.js",
     "dependencies": {},
     "devDependencies": {},
     "scripts": {
       "test": "echo \"Error: no test specified\" && exit 1"
     },
     "keywords": ["api", "database"],
     "author": "Sam",
     "license": "ISC"
   }
   

5. Dans la section scripts, ajoutez un nouveau script nommé start au-dessus du script test :

   "start": "node ./src/index.js",
   

6. Enregistrez vos modifications et fermez le fichier package.json.

7. Démarrez votre projet avec l’action start en entrant cette commande :

   npm start
   

   Cette sortie doit s’afficher :

   Welcome to this application
   

Vous disposez maintenant d’un bon fichier package.json que vous pouvez faire évoluer au fil du développement de votre projet.