Az 5 legnépszerűbb Node.js csomag a CLI-eszközök építéséhez

A parancssori interfész (CLI) a számítógépes programmal vagy operációs rendszerrel való interakció módja szöveges parancsok használatával. A CLI eszköz egy segédprogram, amely parancssorból futtatható. A CLI eszközök jellemzően szöveges parancsokat vesznek át a felhasználótól, és a parancsok alapján hajtanak végre meghatározott feladatokat.

A kiváló minőségű CLI-eszközöknek a funkciók széles skáláját kell támogatniuk. Képesek elemezni a parancssori argumentumokat, és használati segítséget generálnak, hogy vizuális visszajelzést adhassanak, többek között.

Számos Node.js csomag létezik, amelyek segítségével gyorsan létrehozhat CLI-eszközöket, amelyek a funkciók és a rugalmasság széles skáláját kínálják. Itt megtekintheti a CLI-eszközök felépítéséhez használt legnépszerűbb Node.js-csomagokat, és megismerheti a legfontosabb funkcióikat.

A Commander egy Node.js csomag parancssori interfészek létrehozására. API-t biztosít a parancsok, opciók és argumentumok meghatározásához, megkönnyítve a CLI-eszközök létrehozását.

A Commander gondoskodik az argumentumok opciókká és parancssori argumentumokból történő elemzéséről. Ezenkívül hibákat és fel nem ismert opciókat jelenít meg, és automatikusan generál használati súgót (CLI dokumentáció).

A Commander függőségként való telepítéséhez futtassa ezt a parancsot:

npm telepítés parancsnok

Íme egy példa a Commander Node.js alkalmazásban való használatára:

// index.js
const { Parancs } = igényelnek("parancsnok");
// parancspéldány létrehozása
const program = új Parancs();
// eszköz létrehozása
program
 .név("Math-util")
 .leírás("CLI eszköz egyszerű matematikai függvények végrehajtásához")
.változat("1.0.0");
// parancs hozzáadása
program
 .parancs("hozzáadás")
 .leírás("Két szám hozzáadása")
 .érv("", "első szám")
 .érv("", "második szám")
 .akció((a, b) => {
konzol.log(parseInt(a) + parseInt(b));
 });
program.elemzés();

A fenti példa egy CLI-eszköz egyszerű matematikai függvények végrehajtására. A fenti kódblokk megvalósította az „add” funkciót a CLI eszközhöz a commander.js metódusaival.

Használhatja a fenti CLI eszközt a következő parancs futtatásával a terminálon:

csomópont index hozzáadása 2 2

A parancssori eszközhöz automatikusan generált súgót is megtekintheti a következő parancs futtatásával:

csomópont kli -h

A Commander.js csomaggal teljesen felszerelt és működőképes CLI-eszközöket készíthet dokumentációval, egyszerű parancsok segítségével.

Az Inquirer.js egy Node.js csomag interaktív parancssori felhasználói felületek létrehozására. A felhasználói felület összetevőinek készletét, például promptokat, listákat és jelölőnégyzeteket kínál, amelyek megkönnyítik a felhasználóval interakcióba lépő CLI-eszközök létrehozását.

Az Inquirer függőségként való telepítéséhez futtassa ezt a parancsot:

npm telepítés érdeklődő

Íme egy példa az Inquirer.js használatára:

// index.js
import érdeklődő tól től"kérdező";
érdeklődő
 .gyors([
 {
típus: "bemenet",
 név: "név",
 üzenet: "Mi a neved?",
 },
 ])
 .akkor((válaszol) => {
konzol.log(`Szia ${answers.name}`);
 });

Ez a példa az Inquirer.js-t használja a terminálról érkező felhasználói adatok fogadására, és egy üzenetet naplóz, amely üdvözli a felhasználót.

Az Inquirer.js nem támogatja a CommonJS-t modulrendszer. Használnia kell az ES6 modulrendszert, vagy le kell frissítenie a csomagot a 8.0.0 verzióra.

Az Inquirer.js számos testreszabási lehetőséget kínál a promptokhoz, beleértve a választási lehetőségeket, az érvényesítést és az alapértelmezett értékeket, így ideális a felhasználóval interaktív interaktív CLI-eszközök létrehozásához.

A Chalk egy Node.js csomag, amely egyszerű módot biztosít színek hozzáadására a terminál kimenetéhez, megkönnyítve az olvasható és vonzó CLI-eszközök létrehozását.

Nagy rugalmasságot biztosít a szöveg színeinek és stílusának meghatározásában. A Chalk azonban nem használható elszigetelten a CLI-eszközök létrehozásához; olyan csomagokkal kell használnia, mint a Commander és az Inquirer.js.

A Chalk függőségként történő telepítéséhez futtassa ezt a parancsot:

npm telepítés kréta

Íme egy példa arra, hogyan lehet a Chalk segítségével színeket adni a konzol kimenetéhez:

import kréta tól től"kréta";
konzol.log (chalk.blue("Helló Világ!"));
konzol.log(kréta.piros.bátor("Figyelem"));
konzol.log(kréta.fehér.dőlt("siker"));
konzol.log(
kréta.sárga.bgBlue("Ezszövegvanasárgaelőtéréskékháttér")
);

A Chalk számos más módszert kínál a színek és stílusok meghatározására, beleértve aláhúzás, áthúzott, a háttérszínek különféle árnyalatai és még sok más.

A Chalk nem támogatja a CommonJS modulrendszert. Használnia kell az ES6 modulrendszert, vagy le kell frissítenie a csomagot a 4.0.0-s verzióra.

A Chalk egy nagyszerű csomag, amellyel CLI-eszközeit vizuálisan vonzóbbá és olvashatóbbá teheti. Ezenkívül könnyedén integrálhatja meglévő kódjába bonyolult konfiguráció nélkül.

A Node Spinner egy Node.js csomag, amely egyszerű módot biztosít a spinner animáció megjelenítésére a CLI-eszközökben. Ezzel a csomaggal jelezheti, hogy egy hosszan tartó folyamat van folyamatban, és vizuális jelzést adhat a felhasználónak, hogy az eszköz még mindig működik.

A Node Spinner függőségként történő telepítéséhez futtassa ezt a parancsot:

npm telepítés cli-fonó

Íme egy példa a Node Spinner használatára a forgó animáció megjelenítésére:

const Spinner = igényelnek("cli-spinner").Fonógép;
const fonó = új Fonógép("feldolgozás... %s");
spinner.setSpinnerString("|/-\\\\");
fonógép.Rajt();
setTimeout(() => {
 fonó.szöveg = "Feladat elvégezve.";
 setTimeout(() => {
fonógép.állj meg();
 }, 500);
}, 5000);

Ez a kód a programkönyvtárat használja egy pörgető megjelenítésére, amíg a folyamat be nem fejeződik. A kód egy 5 másodpercig tartó műveletet imitál setTimeout. Az idő lejártával a kijelző szövegét „feldolgozás...”-ról „Feladat befejezve”-re módosítja. és 0,5 másodperccel később leállítja a forgót.

A Node Spinner számos testreszabási lehetőséget kínál, például a spinner stílusának és szövegének módosítását. Több pörgetőt is támogat, lehetővé téve különböző animációk megjelenítését a CLI eszköz különböző részeihez.

A Figlet egy Node.js csomag, amely egyszerű módot biztosít a ASCII művészet létrehozása szövegből.

A figlet függőségként való telepítéséhez futtassa ezt a parancsot:

npm telepítés ficska

Íme egy példa arra, hogyan használhatjuk a figlet-et ASCII grafikák generálására:

const ficska = igényelnek("fiiglet");
ficska ("Helló Világ!!", (hiba, adat) => {
 if (err) {
konzol.log("Elnézést, valami nem ment jól");
konzol.dir (err);
Visszatérés;
 }
konzol.log (adatok);
});

A fenti példa ASCII grafikát hoz létre a „Hello World!!” karakterlánccal. a Figlet használatával, és naplózza a konzolra.

A példa futtatása a következő kimenetet eredményezi:

A Figlet számos betűstílust kínál, amelyek segítségével személyre szabhatja az ASCII-grafika megjelenését. Megadhat egy betűstílust, ha átad egy opciós objektumot a ficska funkció.

Például:

ficska ("Helló Világ!!", { font: "Harang" }, (hiba, adat) => {})

A Figlet használata a CLI-eszközben vizuális érdeklődést kölcsönöz eszközeinek, és vonzóbbá teszi azokat a felhasználók számára.

A CLI-eszköz csomagjainak kiválasztásakor figyelembe kell vennie az igényeit, és ki kell választania azokat a csomagokat, amelyek az ezeknek megfelelő funkcionalitást, stílust és kompatibilitást biztosítják.

A Node.js ökoszisztéma különféle csomagokat kínál, amelyek képesek elemezni a parancssori argumentumokat, létrehozni egy parancssori felhasználói felületet, megjeleníteni stilizált szöveget és még sok mást. A megfelelő keverék kihasználásával olyan CLI-eszközöket hozhat létre, amelyek egyszerre rendkívül funkcionálisak és felhasználóbarátak.