Développer une interface en ligne de commande (CLI) avec un module tel que Commander peut s’avérer plus facile à gérer. Bien que Node.js propose des mécanismes intégrés pour traiter les arguments de la ligne de commande, leur gestion peut rapidement devenir complexe à mesure que la CLI s’agrandit. C’est là que Commander devient utile, car il offre les avantages suivants :

• Développement de CLI simplifié : Commander facilite la création d’une CLI en réduisant la complexité, ce qui permet de se concentrer sur la définition des commandes et de leurs fonctions ;
• Descriptions détaillées des commandes et des options : Avec Commander, il est facile de fournir des descriptions pour les commandes et les options, améliorant ainsi la convivialité de la CLI ;
• Analyse automatique des arguments : Commander automatise la procédure d’analyse des arguments de la ligne de commande, ce qui réduit la quantité de code manuel à écrire pour la gestion des arguments.

Installation du module Commander

Pour commencer, il est nécessaire d’installer le module Commander depuis NPM. Pas d’inquiétude, le processus est simple. Avant de pouvoir utiliser le module Commander, il faut l’ajouter à votre projet. Exécutez simplement la commande suivante pour l’installer :

npm install commander

Création de commandes et d’options

Avec Commander, il est possible de définir des commandes, de spécifier leur comportement et même de fournir des descriptions. De plus, il est possible d’expliquer les options qui modifient le comportement des commandes. Voici un aperçu de ce qu’il est possible de réaliser avec Commander :

Définition d'une commande

Pour définir une commande, utiliser la méthode .command() de l'objet program. Structure de base :

program.command('commandName [arguments]')

• commandName : Nom de la commande ;
• [arguments] : Arguments optionnels acceptés par la commande.

Ajout de descriptions de commande

Il est possible de fournir une description à la commande à l'aide de la méthode .description() :

program.command('commandName [arguments]').description('Description of the command');

Gestion des actions de commande

Spécifier l'action à effectuer lors de l'exécution de la commande avec la méthode .action(). C'est ici que la logique associée à la commande est définie :

program.command('commandName [arguments]').action((...arguments) => {
  // Command logic goes here
});

Voici un exemple complet :

program
  .command('greet <name>')
  .description('Greet a person')
  .action((name) => {
    console.log(`Hello, ${name}!`);
  });

Voici l'exemple de code présenté dans la vidéo :

const { program } = require("commander");

program
  .version("1.0.0")
  .command("greet <name>")
  .description("Greet a person")
  .action((name) => {
    console.log(`Hello, ${name}!`);
  });

program.parse(process.argv);

Essayez par vous-même

L'apprentissage est optimal lorsqu'il est pratiqué. Essayez d'exécuter ce code sur votre ordinateur et observez le résultat. Interagissez avec le script et découvrez le plaisir de créer des messages de salutation uniques grâce au module Commander !