Documentation ServBay : Définir une version spécifique de Node.js pour vos projets, scripts et sites Web

ServBay est un environnement de développement web local puissant prenant en charge de nombreux langages et stacks technologiques, dont Node.js. Dans la pratique, vous pouvez avoir besoin d’utiliser une version précise de Node.js pour des projets différents, des scripts individuels ou pour l’ensemble d’un site web. Par exemple, un projet plus ancien peut reposer sur Node.js 14, tandis qu’un nouveau projet nécessite des fonctionnalités récentes de Node.js 20. ServBay vous offre la flexibilité nécessaire pour répondre à ces exigences.

Dans cet article, nous détaillons comment spécifier la version de Node.js à utiliser pour un script ou un site web ainsi que la configuration au niveau du projet dans ServBay.

Spécifier la version de Node.js et la configuration d’un projet avec le fichier .servbay.config

Pour des projets nécessitant un contrôle strict sur la version de Node.js et leurs variables d’environnement, ServBay propose une configuration au niveau du projet, via la création d’un fichier .servbay.config à la racine du répertoire du projet. Ce fichier vous permet de définir la version de Node.js à utiliser, les registres pour les gestionnaires de paquets, les répertoires de cache, etc., garantissant ainsi l’isolation et l’uniformité de l’environnement pour le projet concerné.

Voici un exemple de fichier .servbay.config qui définit une version spécifique de Node.js, un registre npm/yarn ainsi qu’un chemin de cache dédié :

NODE_VERSION=20
YARN_CONFIG_REGISTRY=https://registry.npmmirror.com/ # Exemple : utilisation d’un miroir spécifique
NPM_CONFIG_REGISTRY=https://registry.npmmirror.com/ # Exemple : utilisation d’un miroir spécifique
NPM_CONFIG_CACHE=/Applications/ServBay/tmp/npm/cache # Exemple : désignation du chemin de cache
YARN_CONFIG_CACHE=/Applications/ServBay/tmp/yarn/cache # Exemple : désignation du chemin de cache

Explications :

• NODE_VERSION : Spécifie la version principale de Node.js à utiliser pour ce projet. ServBay recherchera et utilisera la version installée correspondant à ce numéro.
• YARN_CONFIG_REGISTRY, NPM_CONFIG_REGISTRY : Définissent l’URL du registre à utiliser pour npm ou yarn dans le cadre du projet.
• NPM_CONFIG_CACHE, YARN_CONFIG_CACHE : Spécifient le répertoire de cache pour les gestionnaires de paquets npm ou yarn. Dans cet exemple, les sous-répertoires sous /Applications/ServBay/tmp/ sont utilisés par défaut pour ServBay.

En règle générale, placez le fichier .servbay.config à la racine de votre projet. Pour une description détaillée des paramètres et de leur utilisation, reportez-vous à la documentation officielle de ServBay sur le fichier .servbay.config (en anglais ou chinois).

Exécuter des scripts Node.js avec une version spécifique depuis la ligne de commande

Si vous ne souhaitez pas fixer la version de Node.js au niveau du projet mais avez besoin d’exécuter ponctuellement un script ou une commande avec une version précise de Node.js, SerBay propose des alias en ligne de commande adaptés.

Dans l’environnement terminal intégré à ServBay (disponible via l’interface de l’application ServBay), vous pouvez utiliser la commande node-<version> pour sélectionner facilement la version de Node.js qui exécutera votre script. ServBay crée automatiquement ce type d’alias pour chaque version installée de Node.js.

Par exemple, pour exécuter le script script.js avec Node.js 14 :

$ node-14 script.js
Hello World
Node.js Version: 14.17.0 # Exemple de sortie, le numéro de version peut varier

$ node-16 script.js
Hello World
Node.js Version: 16.3.0 # Exemple de sortie, le numéro de version peut varier

$ node-20 script.js
Hello World
Node.js Version: 20.10.0 # Exemple de sortie, le numéro de version peut varier

Explication des exemples

• $ node-14 script.js : Exécute script.js avec la version 14.x.x de Node.js installée dans ServBay (la version exacte dépend de votre installation).
• $ node-16 script.js : Exécute script.js avec la version 16 installée.
• $ node-20 script.js : Exécute script.js avec la version 20 installée.

Cette méthode vous permet de tester la compatibilité entre différentes versions de Node.js ou d’exécuter rapidement des tâches nécessitant une version spécifique de Node.js, sans changer la version globale du système.

Définir une version de Node.js pour un site web via l’interface de gestion ServBay

ServBay permet de spécifier directement, depuis son interface de gestion, la version par défaut de Node.js pour chaque site hébergé. Cette fonctionnalité est particulièrement utile pour des sites utilisant Node.js côté serveur (par exemple des applications Express.js, Next.js, NestJS, sous proxy inversé via Caddy ou Nginx), ou nécessitant une version précise de Node.js.

Étapes

1. Ouvrir l’interface de gestion ServBay : Lancez l’application ServBay et accédez à l’interface de gestion via votre navigateur (par défaut sur http://localhost:5200 ou le lien fourni dans la fenêtre principale de l’application).

2. Accéder à la gestion des sites web : Dans le menu de navigation à gauche, cliquez sur « Sites Web » (Website).

3. Sélectionner et éditer un site : Dans la liste, trouvez le site que vous souhaitez configurer (par exemple, un site situé dans /Applications/ServBay/www/servbay.demo). Cliquez sur le bouton d’édition à droite du nom du site (icône engrenage ou crayon), ou cliquez directement sur le nom du site pour accéder à la page de détails.

4. Choisir la version de Node.js : Dans la page de configuration du site, repérez le réglage relatif à la version de Node.js (souvent sous forme de menu déroulant). Sélectionnez la version de Node.js souhaitée à utiliser par défaut pour ce site.

5. Enregistrer les modifications : Après sélection, cliquez sur « Enregistrer » ou « Appliquer » en bas de page afin de sauvegarder vos modifications.

6. Redémarrer le site ou ServBay si nécessaire : Certaines modifications nécessitent de redémarrer le serveur web correspondant (Caddy, Nginx) ou l’application ServBay pour être prises en compte. ServBay affiche alors une notification pour vous indiquer s’il est nécessaire de relancer des services.

Points d’attention :

• Versions Node.js installées et actives : La version de Node.js sélectionnée dans la configuration du site doit déjà être installée et active dans l’onglet « Paquets » (Packages) de ServBay. Si ce n’est pas le cas, allez d’abord installer ou activer la version correspondante via la page « Paquets ».
• Type de site web : Ce réglage concerne les sites s’appuyant réellement sur Node.js pour fonctionner (Express.js, Next.js, NestJS…), et a peu d’impact sur les sites statiques ou reposant intégralement sur d’autres langages côté serveur (PHP, Python, Go…).
• Compatibilité : Après avoir changé la version de Node.js d’un site, testez minutieusement l’ensemble de ses fonctionnalités pour vous assurer que toutes les dépendances fonctionnent correctement sans problème de compatibilité.
• Interaction avec .servbay.config : Le réglage au niveau du site fournit une valeur par défaut, mais si un fichier .servbay.config est présent dans le répertoire du projet et y spécifie NODE_VERSION, cette version prévaudra sur celle configurée dans l’interface web. La configuration au niveau projet dispose d’une priorité supérieure pour un contrôle plus granulaire.

Conclusion

ServBay, en tant qu’environnement de développement local complet, offre de multiples moyens simples et puissants pour gérer la version de Node.js utilisée sur vos projets. Qu’il s’agisse de tirer parti d’un fichier .servbay.config à la racine de votre projet pour un contrôle précis et une configuration des variables d’environnement, d’exécuter rapidement des scripts via la syntaxe de commande node-<version>, ou bien de choisir la version Node.js par défaut depuis l’interface de gestion ServBay pour vos sites web : toutes ces options vous assurent de pouvoir répondre efficacement aux besoins variés de vos projets. Que ce soit pour garantir la compatibilité d’un ancien code, tester de nouvelles fonctionnalités ou maintenir la cohérence entre environnement de développement et de production, ServBay simplifie la gestion des versions et vous permet d’optimiser votre productivité.