Comment activer et utiliser npm (Node.js Package Manager) dans ServBay

npm (Node Package Manager) est l’outil officiel de gestion de paquets de Node.js ainsi que l’un des plus grands registres de logiciels open source au monde. Pour les développeurs Node.js, npm est un outil essentiel qui facilite l’installation, le partage et la gestion des dépendances de code au sein des projets. Grâce à l’environnement intégré fourni par ServBay, vous pouvez rapidement commencer à développer avec npm.

Prérequis

Avant d’utiliser npm, vous devez d’abord installer Node.js via ServBay.

1. Ouvrez l’application ServBay.
2. Accédez au panneau « Packages » (Paquets).
3. Repérez le paquet Node.js et vérifiez qu’il est bien installé et en cours d’exécution.

ServBay configure automatiquement l’environnement Node.js, incluant npm.

Vérifier que npm est installé et disponible

La version de Node.js installée par ServBay comprend déjà npm, activé par défaut. Pour vérifier rapidement que npm est bien installé et accessible, procédez via le terminal.

1. Ouvrez votre application de terminal (comme Terminal sur macOS).

2. Saisissez la commande suivante pour afficher la version de npm :

   npm -v

   Si la commande s’exécute correctement et affiche un numéro de version (par exemple 10.2.0 ou supérieur), cela signifie que npm est installé et directement utilisable dans votre environnement.

   # Exemple de sortie
   10.2.0

   Si un message d’erreur du type « command not found: npm » apparaît, assurez-vous d’avoir bien installé le paquet Node.js via ServBay et que les variables d’environnement de ServBay soient chargées correctement (généralement, redémarrer le terminal ou l’ordinateur règle ce souci).

Mettre à jour npm

Bien que la version de Node.js fournie par ServBay embarque une version stable de npm, cet outil évolue fréquemment indépendamment de Node.js. Pour bénéficier des dernières fonctionnalités et corrections, vous pouvez mettre à jour npm via lui-même :

npm install -g npm@latest

Cette commande installe la dernière version de npm globalement. L’option -g indique une installation globale, vous permettant d’accéder à la dernière version de npm où que vous soyez sur votre système.

Après la mise à jour, vérifiez la version avec la commande suivante :

npm -v

Fonctionnalités clés de npm et usages courants

La force de npm réside dans l’immensité de son écosystème open source et ses capacités de gestion des dépendances. Voici quelques scénarios et commandes typiques pour un développement quotidien :

Initialiser un nouveau projet Node.js

Pour démarrer un nouveau projet Node.js dans un dossier vide, utilisez la commande npm init pour générer un fichier package.json. Ce fichier est le cœur du projet, contenant ses métadonnées, les dépendances, les scripts disponibles, etc.

cd /Applications/ServBay/www/my-new-project.servbay.demo
npm init

npm init vous guide pour renseigner le nom du projet, la version, la description, le fichier d’entrée, etc. Pour une création rapide, utilisez npm init -y, qui génère un package.json avec les valeurs par défaut.

Installer les dépendances d’un projet

Dans le dossier racine de votre projet (où se trouve le fichier package.json), utilisez la commande npm install pour installer toutes les dépendances requises.

cd /Applications/ServBay/www/my-project.servbay.demo
npm install

Cette commande lit les champs dependencies et devDependencies de package.json et télécharge les modules nécessaires dans le dossier node_modules du projet.

Ajouter une nouvelle dépendance

Si votre projet requiert une nouvelle bibliothèque ou un framework, utilisez la commande npm install <package-name>.

# Installer une dépendance de production, par exemple le framework Express
npm install express

# Installer une dépendance de développement, comme l’outil de test Mocha
npm install mocha --save-dev

Par défaut, npm install <package-name> ajoute le paquet au dossier node_modules et met automatiquement à jour le champ dependencies du fichier package.json. L’option --save-dev ajoute le paquet dans devDependencies, utilisé pour le développement, les tests ou les outils de build.

Supprimer une dépendance

Si une dépendance n’est plus nécessaire, utilisez la commande npm uninstall <package-name> pour la retirer.

npm uninstall express

Cette opération supprime le paquet du dossier node_modules et met à jour le fichier package.json.

Mettre à jour les dépendances du projet

Pour vous assurer que les versions des dépendances sont à jour (dans les plages définies par package.json), utilisez :

npm update

Cette commande analyse les paquets déjà installés dans node_modules et effectue les mises à jour selon les versions compatibles indiquées.

Utilisation des scripts npm

Le champ scripts de votre fichier package.json permet de définir des scripts personnalisés à exécuter en ligne de commande. C’est une méthode très pratique pour automatiser des tâches répétitives : lancer un serveur de développement, exécuter des tests, compiler ou builder un projet, etc.

Par exemple, voici comment structurer les scripts dans package.json :

{
  "name": "my-project",
  "version": "1.0.0",
  "scripts": {
    "start": "node index.js",
    "test": "mocha test/**/*.js",
    "build": "webpack --config webpack.config.js"
  },
  "dependencies": {
    "express": "^4.18.2"
  },
  "devDependencies": {
    "mocha": "^10.2.0",
    "webpack": "^5.89.0"
  }
}

Ensuite, lancez les scripts en terminal via la commande npm run <script-name> :

# Démarrer l’application
npm start

# Exécuter les tests
npm test

# Lancer la construction du projet
npm run build

À noter : pour certains noms de scripts particuliers comme start, test, install, restart, stop, il est possible d’omettre run et d’utiliser directement npm start, npm test, etc.

Aide-mémoire des commandes npm courantes

En plus des usages ci-dessus, voici une sélection de commandes npm utiles :

• Installer un paquet globalement : pour installer des outils CLI accessibles partout.

  npm install -g <package-name>
  # Par exemple, installer npx pour exécuter des commandes temporaires (souvent inclus avec Node.js)
  npm install -g npx
  # Ou l’outil courant nodemon pour relancer des apps automatiquement durant le développement
  npm install -g nodemon

• Exécuter des commandes temporaires (npx) : npx (inclus avec npm 5.2+) permet d’exécuter des binaires depuis node_modules/.bin ou d’exécuter temporairement la commande d’un paquet sans installation globale.

  # Créer un nouveau projet React sans installer create-react-app globalement
  npx create-react-app my-react-app

• Lister les paquets globaux : afficher tous les paquets installés globalement et leurs versions.

  npm list -g --depth=0

• Nettoyer le cache npm : en cas de problème d’installation, nettoyer le cache peut aider.

  npm cache clean --force

• Afficher les infos d’un paquet : obtenir les détails sur un paquet : versions, dépendances, dépôt, etc.

  npm view <package-name>

• Rechercher un paquet : faire une recherche dans le registre npm.

  npm search <keyword>

Dépannage

• npm command not found : Vérifiez que Node.js est bien installé avec ServBay et que votre session terminal pointe vers les chemins d’installation de Node.js et npm. Redémarrer le terminal ou l’ordinateur résout souvent le problème.
• Échec d’installation de dépendances : Vérifiez votre connexion réseau. L’utilisation d’un proxy d’entreprise peut affecter npm, il peut être nécessaire de configurer le proxy dans npm. Essayez aussi de nettoyer le cache (npm cache clean --force) avant de réessayer.
• Problèmes de permissions : Sur macOS, l’installation globale (npm install -g) peut parfois poser des soucis de droits. Utilisez de préférence un gestionnaire de versions Node comme nvm, ou vérifiez que ServBay a bien configuré les chemins d’installation. Évitez de recourir à sudo pour installer globalement afin d’éviter des conflits plus complexes. Node.js fourni par ServBay gère normalement ces droits et permet à l’utilisateur d’opérer dans le dossier d’installation de ServBay.

Conclusion

Avec ServBay, vous pouvez facilement mettre en place un environnement Node.js complet en local et profiter immédiatement de la puissance de l’outil npm pour la gestion des paquets et le développement de vos projets. Maîtriser les commandes clés et les usages courants de npm boostera grandement votre efficacité. À mesure que vous explorerez l’écosystème Node.js, npm deviendra un allié incontournable pour vos développements.