Komentorivikäyttöliittymän (CLI) kehittäminen moduulin, kuten Commanderin, avulla on hallittavampaa. Vaikka Node.js tarjoaa sisäänrakennetut mekanismit komentoriviparametrien käsittelyyn, niiden hallinta voi nopeasti muuttua monimutkaiseksi CLI:n laajentuessa. Tässä Commander on hyödyllinen, sillä se tarjoaa seuraavat edut:

• Yksinkertaistettu CLI-kehitys: Commander helpottaa CLI:n luomista vähentämällä monimutkaisuutta, jolloin voimme keskittyä komentojen ja niiden toimintojen määrittelyyn;
• Yksityiskohtaiset komentojen ja valintojen kuvaukset: Commanderilla voimme helposti lisätä kuvauksia komennoille ja valinnoille, mikä parantaa CLI:n käytettävyyttä;
• Automaattinen argumenttien jäsentäminen: Commander automatisoi komentoriviparametrien jäsentämisen, mikä vähentää manuaalisen argumenttikoodin tarvetta.

🔌 Commanderin asentaminen

Aloittaaksemme meidän täytyy asentaa Commander-moduuli NPM:stä. Älä huoli, prosessi on suoraviivainen. Ennen kuin voimme käyttää Commander-moduulia, meidän täytyy lisätä se projektiimme. Suorita seuraava komento asentaaksesi sen:

npm install commander

🔧 Komentojen ja valintojen luominen

Commander-moduulilla voidaan määrittää komentoja, kuvata niiden toiminta ja antaa niille selityksiä. Lisäksi voidaan määritellä valintoja, jotka muuttavat komentojen toimintaa. Tässä esimerkki siitä, mitä Commanderilla voidaan saavuttaa:

Komennon määrittely

Komento määritellään ohjelma-olion .command()-metodilla. Perusrakenne:

program.command('commandName [arguments]')

• commandName: Komennon nimi;
• [arguments] : Valinnaiset argumentit, jotka komento hyväksyy.

Komennon kuvauksen lisääminen

Komennolle voidaan antaa kuvaus käyttämällä .description()-metodia:

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

Komentotoimintojen käsittely

Määritä suoritettava toiminto komennon käynnistyessä käyttämällä .action()-metodia. Tässä määritellään komennon logiikka:

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

Tässä on täydellinen esimerkki:

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

Tässä on videon esimerkkikoodi:

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

👨‍💻 Kokeile itse!

Oppiminen on tehokkainta käytännön harjoittelun kautta. Kokeile ajaa tämä koodi omalla tietokoneellasi ja seuraa, mitä tapahtuu. Vuorovaikuta skriptin kanssa ja koe ainutlaatuisten tervehdysviestien luomisen innostus Commander-moduulin avulla!