Framework CLI JavaScript (Node.js) Commander.js

Commander.js : Création d'applications console puissantes avec Node.js

Dans le monde du développement web moderne et de l'automatisation, les applications console (CLI) jouent un rôle clé. Elles permettent d'automatiser les tâches répétitives, de gérer des projets, de déployer du code et d'interagir avec des API sans utiliser d'interface graphique. Si vous codez en JavaScript (Node.js), le meilleur choix pour créer des outils CLI élégants et fonctionnels est le framework Commander.js.

Commander.js est une bibliothèque légère mais incroyablement puissante qui prend en charge toute la routine d'analyse des arguments de ligne de commande, de génération d'aide et de gestion des erreurs. Avec elle, vous pouvez transformer un simple script en une application console professionnelle prenant en charge les sous-commandes, les options et la validation automatique. Dans cet article, nous allons détailler comment utiliser Commander.js sur le site éducatif pythonlib.ru pour créer vos propres utilitaires CLI.

Installation et utilisation de base

Avant de commencer, assurez-vous d'avoir Node.js installé (version 12 ou supérieure). L'installation de Commander.js se fait via npm :

npm install commander

Après l'installation, créez un fichier cli.js et importez la bibliothèque. Voici un exemple simple — une application qui affiche "Bonjour, le monde !" et accepte le nom d'un utilisateur.

#!/usr/bin/env nodeconst { Command } = require('commander');const program = new Command();

program  .name('greet')  .description('Affiche un message de bienvenue')  .version('1.0.0');

program  .command('hello')  .description('Saluer un utilisateur')  .argument('<name>', 'Nom de l\\'utilisateur')  .action((name) => {    console.log(`Bonjour, ${name} ! Bienvenue dans Commander.js.`);  });

program.parse(process.argv);

Exécutez maintenant le script :

node cli.js hello Jean

Vous verrez : Bonjour, Jean ! Bienvenue dans Commander.js.

Fonctionnalités principales de Commander.js

Commander.js offre un ensemble riche de fonctionnalités pour créer des applications CLI professionnelles. Examinons-les en détail.

1. Commandes et sous-commandes

Vous pouvez créer un nombre illimité de commandes (par exemple, init, build, deploy) et les imbriquer les unes dans les autres. C'est particulièrement utile pour des outils complexes comme les gestionnaires de paquets ou les assembleurs de projets.

program  .command('init')  .description('Initialise un nouveau projet')  .option('-t, --template <type>', 'Modèle de projet (basic, advanced)')  .action((options) => {    console.log(`Création du projet avec le modèle : ${options.template || 'basic'}`);  });

2. Options (drapeaux)

Les options permettent à l'utilisateur de passer des paramètres supplémentaires. Commander.js prend en charge les drapeaux courts (-v) et longs (--verbose), ainsi que les valeurs obligatoires et facultatives.

program  .option('-d, --debug', 'Activer le mode débogage')  .option('-p, --port <number>', 'Port du serveur', '3000') // valeur par défaut  .parse(process.argv);

if (program.opts().debug) {  console.log('Débogage activé');}

3. Arguments de commande

Les arguments sont des paramètres positionnels que l'utilisateur transmet après la commande. Ils peuvent être obligatoires (<name>) ou facultatifs ([name]).

program  .command('copy <source> [destination]')  .description('Copie un fichier de source vers destination')  .action((source, destination) => {    console.log(`Copie de ${source} vers ${destination || 'le dossier actuel'}`);  });