Desenvolver uma interface de linha de comando (CLI) com um módulo como o Commander pode ser mais gerenciável. Embora o Node.js ofereça mecanismos integrados para lidar com argumentos de linha de comando, eles podem rapidamente se tornar complicados à medida que a CLI se expande. É nesse ponto que o Commander se torna útil, pois oferece os seguintes benefícios:

• Desenvolvimento de CLI simplificado: O Commander simplifica a criação de uma CLI ao minimizar a complexidade, permitindo o foco na definição de comandos e suas funções;
• Descrições detalhadas de comandos e opções: Com o Commander, é possível fornecer rapidamente descrições para comandos e opções, aumentando a facilidade de uso da CLI;
• Análise automática de argumentos: O Commander automatiza o procedimento de análise dos argumentos da linha de comando, o que reduz o código manual necessário para lidar com argumentos.

🔌 Instalando o módulo Commander

Para começar, é necessário instalar o módulo Commander a partir do NPM. Não se preocupe, o processo é simples. Antes de começar a utilizar o módulo Commander, é preciso adicioná-lo ao projeto. Basta executar o seguinte comando para instalá-lo:

npm install commander

🔧 Criando Comandos e Opções

Com o Commander, é possível definir comandos, especificar seu comportamento e fornecer descrições. Além disso, é possível explicar opções que modificam o comportamento dos comandos. Veja um exemplo do que pode ser realizado com o Commander:

Definição de um Comando

Para definir um comando, utilize o método .command() do objeto program. Estrutura básica:

program.command('commandName [arguments]')

• commandName: Nome do comando;
• [arguments] : Argumentos opcionais aceitos pelo comando.

Adicionando Descrições ao Comando

É possível fornecer uma descrição para o comando utilizando o método .description():

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

Manipulação de Ações de Comando

Especificar a ação a ser executada quando o comando for chamado utilizando o método .action(). É neste ponto que a lógica associada ao comando é definida:

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

Exemplo completo:

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

Exemplo de código apresentado no vídeo:

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);

👨‍💻 Experimente Você Mesmo!

A aprendizagem é mais eficaz por meio da prática. Execute este código em seu computador e observe os resultados. Interaja com o script e aproveite a experiência de criar mensagens de saudação personalizadas com o auxílio do Commander!