Å utvikle et kommandolinjegrensesnitt (CLI) med et modul som Commander kan gjøre prosessen mer håndterbar. Selv om Node.js tilbyr innebygde mekanismer for å håndtere kommandolinjeargumenter, kan disse raskt bli kompliserte å administrere etter hvert som CLI-et vokser. Det er her Commander er nyttig, da det gir følgende fordeler:

• Effektiv CLI-utvikling: Commander forenkler opprettelsen av et CLI ved å redusere kompleksiteten, slik at vi kan fokusere på å definere kommandoer og deres funksjoner;
• Detaljerte beskrivelser av kommandoer og alternativer: Med Commander kan vi enkelt legge til beskrivelser for kommandoer og alternativer, noe som øker brukervennligheten til CLI-et;
• Automatisk argumentparsing: Commander automatiserer prosessen med å tolke kommandolinjeargumenter, noe som reduserer mengden manuell kode vi må skrive for å håndtere argumenter.

🔌 Installere Commander-modulen

For å komme i gang må vi installere Commander-modulen fra NPM. Prosessen er enkel. Før vi kan begynne å bruke Commander-modulen, må vi legge den til i prosjektet vårt. Kjør følgende kommando for å installere den:

npm install commander

🔧 Opprette kommandoer og alternativer

Med Commander kan vi definere kommandoer, spesifisere deres oppførsel og til og med legge til beskrivelser. I tillegg kan vi forklare alternativer som endrer oppførselen til kommandoene. Her er et glimt av hva vi kan oppnå med Commander:

Definere en kommando

For å definere en kommando, bruk .command()-metoden til programobjektet. Her er den grunnleggende strukturen:

program.command('commandName [arguments]')

• commandName: Navnet på kommandoen;
• [arguments] : Valgfrie argumenter som kommandoen aksepterer.

Legge til kommando-beskrivelser

Vi kan legge til en beskrivelse for kommandoen ved å bruke .description()-metoden:

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

Håndtering av kommandohandlinger

Angi handlingen som skal utføres når kommandoen kjøres ved å bruke .action()-metoden. Her defineres logikken som er knyttet til kommandoen:

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

Her er et komplett eksempel:

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

Her er kodeeksempelet fra videoen:

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

👨‍💻 Prøv selv!

Læring oppleves best gjennom praktisk øvelse. Prøv å kjøre denne koden på din egen datamaskin og se hva som skjer. Interager med skriptet og opplev gleden ved å lage unike hilsningsmeldinger ved hjelp av Commander!