Näiden kirjastojen ja apuohjelmien avulla voit luoda nykyaikaisia ​​CLI-ohjelmia, joissa on kaikki tarvitsemasi kellot ja pillit.

Komentorivikäyttöliittymä (CLI) on tapa olla vuorovaikutuksessa tietokoneohjelman tai käyttöjärjestelmän kanssa tekstipohjaisten komentojen avulla. CLI-työkalu on apuohjelma, jonka voit suorittaa komentoriviltä. CLI-työkalut ottavat yleensä tekstipohjaisia ​​komentoja käyttäjältä ja suorittavat tiettyjä tehtäviä komentojen perusteella.

Laadukkaiden CLI-työkalujen tulisi tukea monenlaisia ​​toimintoja. He voivat jäsentää komentoriviargumentteja ja luoda käyttöapua visuaalisen palautteen antamiseksi muiden ominaisuuksien ohella.

On olemassa useita Node.js-paketteja, joiden avulla voit nopeasti rakentaa CLI-työkaluja, jotka tarjoavat laajan valikoiman toimintoja ja joustavuutta. Täällä voit tutustua joihinkin suosituimpiin Node.js-paketteihin CLI-työkalujen rakentamiseen ja tutustua niiden tärkeimpiin ominaisuuksiin.

Commander on Node.js-paketti komentoriviliittymien rakentamiseen. Se tarjoaa API: n komentojen, vaihtoehtojen ja argumenttien määrittämiseen, mikä tekee CLI-työkalujen luomisesta helppoa.

instagram viewer

Commander huolehtii argumenttien jäsentämisestä vaihtoehdoiksi ja komentoriviargumenteiksi. Lisäksi se näyttää virheitä ongelmista ja tunnistamattomista vaihtoehdoista ja luo automaattisesti käyttöapua (CLI-dokumentaatio).

Asenna Commander riippuvuutena suorittamalla tämä komento:

npm Asentaa komentaja

Tässä on esimerkki Commanderin käytöstä Node.js-sovelluksessa:

// index.js
konst { Komento } = vaatia("komentaja");
// komennon esiintymän luominen
konst ohjelma = Uusi Komento();


// luontityökalu
ohjelmoida
 .nimi("Math-util")
 .kuvaus("CLI-työkalu yksinkertaisten matemaattisten toimintojen suorittamiseen")
.versio("1.0.0");


// komennon lisääminen
ohjelmoida
 .komento("lisätä")
 .kuvaus("Lisää kaksi numeroa")
 .Perustelu("", "ensimmäinen numero")
 .Perustelu("", "toinen numero")
 .toiminta((a, b) => {
konsoli.Hirsi(parseInt(a) + parseInt(b));
 });
ohjelmoida.jäsentää();

Yllä oleva esimerkki on CLI-työkalu yksinkertaisten matemaattisten toimintojen suorittamiseen. Yllä oleva koodilohko toteutti CLI-työkalun "lisää"-toiminnon käyttämällä commander.js: n menetelmiä.

Voit käyttää yllä olevaa CLI-työkalua suorittamalla tämän komennon päätteessäsi:

solmuindeksi lisää 2 2

Voit myös tarkastella automaattisesti luotua ohjetta CLI-työkalulle suorittamalla seuraava komento:

solmu cli -h

Commander.js-paketin avulla voit rakentaa täysin varusteltuja ja toimivia CLI-työkaluja dokumentaatioineen yksinkertaisten komentojen avulla.

Inquirer.js on Node.js-paketti interaktiivisten komentorivikäyttöliittymien rakentamiseen. Se tarjoaa joukon käyttöliittymäkomponentteja, kuten kehotteita, luetteloita ja valintaruutuja, joiden avulla on helppo rakentaa CLI-työkaluja, jotka voivat olla vuorovaikutuksessa käyttäjän kanssa.

Asenna Inquirer riippuvuutena suorittamalla tämä komento:

npm Asentaa tiedustelija

Tässä on esimerkki Inquirer.js: n käytöstä:

// index.js
tuonti tiedustelija alkaen"kysyjä";
tiedustelija
 .prompt([
 {
tyyppi: "syöttö",
 nimi: "nimi",
 viesti: "Mikä sinun nimesi on?",
 },
 ])
 .sitten((vastauksia) => {
konsoli.Hirsi(`Hei ${answers.name}`);
 });

Tämä esimerkki käyttää Inquirer.js: ää ottamaan käyttäjän syötteen päätteestä ja kirjaamaan käyttäjälle tervehdysviestin.

Inquirer.js ei tue CommonJS: ää moduulijärjestelmä. Sinun on käytettävä ES6-moduulijärjestelmää tai päivitettävä paketti versioon 8.0.0.

Inquirer.js tarjoaa monia mukautusvaihtoehtoja kehotteille, mukaan lukien valinnat, vahvistus ja oletusarvot, mikä tekee siitä ihanteellisen vuorovaikutteisten CLI-työkalujen rakentamiseen, jotka voivat olla vuorovaikutuksessa käyttäjän kanssa.

Chalk on Node.js-paketti, joka tarjoaa yksinkertaisen tavan lisätä värejä päätteen ulostuloon, mikä tekee luettavien ja houkuttelevien CLI-työkalujen luomisesta helppoa.

Se tarjoaa paljon joustavuutta tekstin värien ja tyylien määrittämisessä. Et kuitenkaan voi käyttää Chalkia yksinään CLI-työkalujen rakentamiseen; sinun on käytettävä sitä pakettien, kuten Commander ja Inquirer.js kanssa.

Asenna Chalk riippuvuutena suorittamalla tämä komento:

npm Asentaa liitu

Tässä on esimerkki siitä, kuinka Chalkilla lisätään värejä konsolin ulostuloon:

tuonti liitu alkaen"liitu";
konsoli.log (chalk.blue("Hei maailma!"));
konsoli.Hirsi(liitu.punainen.lihavoitu("Varoitus"));
konsoli.Hirsi(liitu.valkoinen.kursivointi("menestys"));
konsoli.Hirsi(
liitu.keltainen.bgBlue("Tämätekstionakeltainenetualallajasininentausta")
);

Liitu tarjoaa monia muita menetelmiä värien ja tyylien määrittämiseen, mukaan lukien korostaa, yliviivattu, erilaisia ​​taustavärien sävyjä ja monia muita.

Chalk ei tue CommonJS-moduulijärjestelmää. Sinun on käytettävä ES6-moduulijärjestelmää tai päivitettävä paketti versioon 4.0.0.

Chalk on loistava paketti, joka tekee CLI-työkaluistasi visuaalisesti houkuttelevampia ja luettavampia. Lisäksi voit helposti integroida sen olemassa olevaan koodiisi ilman monimutkaisia ​​määrityksiä.

Node Spinner on Node.js-paketti, joka tarjoaa yksinkertaisen tavan näyttää spinner-animaatio CLI-työkaluissasi. Voit käyttää tätä pakettia osoittamaan, että pitkäkestoinen prosessi on käynnissä, ja antaa käyttäjälle visuaalisen vihjeen, että työkalu toimii edelleen.

Asenna Node Spinner riippuvuutena suorittamalla tämä komento:

npm Asentaa cli-spinner

Tässä on esimerkki siitä, kuinka Node Spinneria käytetään spinner-animaatioiden näyttämiseen:

konst Spinner = vaatia("cli-spinner").Spinner;
konst spinner = Uusi Spinner("käsitellään... %s");
spinner.setSpinnerString("|/-\\\\");
spinner.alkaa();


setTimeout(() => {
 spinner.text = "Tehtävä suoritettu.";
 setTimeout(() => {
spinner.lopettaa();
 }, 500);
}, 5000);

Tämä koodi käyttää kirjastoa näyttämään spinneriä, kunnes prosessi on valmis. Koodi jäljittelee toimintoa, joka kestää 5 sekuntia käytettäessä setTimeout. Ajan päätyttyä se muuttaa näytön tekstin "käsitellään..." tilaksi "Tehtävä suoritettu". ja pysäyttää pyörittimen 0,5 sekuntia myöhemmin.

Node Spinner tarjoaa joukon mukautusvaihtoehtoja, kuten spinnerin tyylien ja tekstin muuttamisen. Se tukee myös useita spinnereita, jolloin voit näyttää erilaisia ​​animaatioita CLI-työkalusi eri osille.

Figlet on Node.js-paketti, joka tarjoaa yksinkertaisen tavan luoda ASCII-taidetta tekstistä.

Jos haluat asentaa figletin riippuvuutena, suorita tämä komento:

npm Asentaa figulla

Tässä on esimerkki figletin käyttämisestä ASCII-kuvan luomiseen:

konst figulla = vaatia("figlet");
figlet("Hei maailma!!", (err, data) => {
 jos (err) {
konsoli.Hirsi("Pahoittelut, jotain meni pieleen");
konsoli.dir (err);
palata;
 }
konsoli.log (data);
});

Yllä oleva esimerkki luo ASCII-taidetta merkkijonolla "Hello World!!" käyttämällä Figletiä ja kirjaa sen konsoliin.

Tämän esimerkin suorittamisen pitäisi tuottaa seuraava tulos:

Figlet tarjoaa monia kirjasintyylejä, joiden avulla voit mukauttaa ASCII-kuvasi ulkoasua. Voit määrittää fonttityylin välittämällä asetukset-objektin figulla toiminto.

Esimerkiksi:

figlet("Hei maailma!!", { font: "Kello" }, (err, data) => {})

Figletin käyttäminen CLI-työkalussa lisää visuaalista mielenkiintoa työkaluihisi ja tekee niistä kiinnostavampia käyttäjillesi.

Kun valitset paketteja CLI-työkalullesi, sinun on otettava huomioon tarpeesi ja valittava paketit, jotka tarjoavat niitä vastaavan toiminnallisuuden, tyylin ja yhteensopivuuden.

Node.js-ekosysteemi tarjoaa erilaisia ​​paketteja, jotka voivat jäsentää komentorivin argumentteja, luoda komentorivikäyttöliittymän, näyttää tyyliteltyä tekstiä ja paljon muuta. Oikean yhdistelmän hyödyntäminen antaa sinun luoda CLI-työkaluja, jotka ovat sekä erittäin toimivia että käyttäjäystävällisiä.