Korzystaj z tych bibliotek i narzędzi do tworzenia nowoczesnych programów CLI ze wszystkimi potrzebnymi dzwonkami i gwizdkami.
Interfejs wiersza poleceń (CLI) to sposób interakcji z programem komputerowym lub systemem operacyjnym za pomocą poleceń tekstowych. Narzędzie CLI to program narzędziowy, który można uruchomić z wiersza poleceń. Narzędzia CLI zwykle pobierają polecenia tekstowe od użytkownika i wykonują określone zadania na podstawie tych poleceń.
Wysokiej jakości narzędzia CLI powinny obsługiwać szeroki zakres funkcjonalności. Mogą analizować argumenty wiersza poleceń i generować pomoc dotyczącą użytkowania, aby zapewnić wizualną informację zwrotną, między innymi.
Istnieje kilka pakietów Node.js, które mogą pomóc w szybkim tworzeniu narzędzi CLI, oferując szeroki zakres funkcjonalności i elastyczności. Tutaj zapoznasz się z niektórymi z najlepszych pakietów Node.js do tworzenia narzędzi CLI i odkryjesz ich kluczowe funkcje.
Commander to pakiet Node.js do budowania interfejsów wiersza poleceń. Zapewnia interfejs API do definiowania poleceń, opcji i argumentów, ułatwiając tworzenie narzędzi CLI.
Commander zajmuje się parsowaniem argumentów na opcje i argumenty wiersza poleceń. Dodatkowo wyświetla błędy dotyczące problemów i nierozpoznanych opcji oraz automatycznie generuje pomoc użytkową (dokumentacja CLI).
Aby zainstalować Commander jako zależność, uruchom to polecenie:
np zainstalować dowódca
Oto przykład użycia Commandera w aplikacji Node.js:
// index.js
konst { Polecenie } = wymagać("dowódca");// tworzenie instancji polecenia
konst program = nowy Komenda();// tworzenie narzędzia
program
.nazwa(„Narzędzie matematyczne”)
.opis(„Narzędzie CLI do wykonywania prostych funkcji matematycznych”)
.wersja("1.0.0");// dodanie polecenia
program
.Komenda("dodać")
.opis(„Dodaj dwie liczby”)
.argument("" , „pierwszy numer”)
.argument("" , „drugi numer”)
.działanie((a, b) => {
konsola.dziennik(parseInt(a) + parseInt(B));
});
program.analizować();
Powyższy przykład to narzędzie CLI do wykonywania prostych funkcji matematycznych. Powyższy blok kodu zaimplementował funkcję „dodawania” narzędzia CLI przy użyciu metod z pliku commander.js.
Możesz użyć powyższego narzędzia CLI, uruchamiając to polecenie w swoim terminalu:
indeks węzła dodaj 2 2
Możesz także wyświetlić automatycznie wygenerowaną pomoc dla narzędzia CLI, uruchamiając to polecenie:
węzeł cli -h
Dzięki pakietowi Commander.js możesz tworzyć w pełni funkcjonalne i funkcjonalne narzędzia CLI z dokumentacją od razu po wyjęciu z pudełka za pomocą prostych poleceń.
Inquirer.js to pakiet Node.js do tworzenia interaktywnych interfejsów użytkownika wiersza poleceń. Zapewnia zestaw komponentów interfejsu użytkownika, takich jak monity, listy i pola wyboru, ułatwiając tworzenie narzędzi CLI, które mogą wchodzić w interakcje z użytkownikiem.
Aby zainstalować Inquirer jako zależność, uruchom to polecenie:
np zainstalować informujący się
Oto przykład użycia Inquirer.js:
// index.js
import informujący się z"informujący się";
informujący się
.podpowiedź([
{
typ: "wejście",
nazwa: "nazwa",
wiadomość: "Jak masz na imię?",
},
])
.Następnie((odpowiedzi) => {
konsola.dziennik(`Cześć ${answers.name}`);
});
W tym przykładzie użyto Inquirer.js do pobrania danych wejściowych użytkownika z terminala i zarejestrowania komunikatu powitalnego dla użytkownika.
Inquirer.js nie obsługuje CommonJS układ modułowy. Musisz użyć systemu modułów ES6 lub obniżyć pakiet do wersji 8.0.0.
Inquirer.js zapewnia wiele opcji dostosowywania monitów, w tym wyborów, sprawdzania poprawności i wartości domyślnych, dzięki czemu idealnie nadaje się do tworzenia interaktywnych narzędzi CLI, które mogą wchodzić w interakcje z użytkownikiem.
Chalk to pakiet Node.js, który zapewnia prosty sposób dodawania kolorów do danych wyjściowych terminala, ułatwiając tworzenie czytelnych i atrakcyjnych narzędzi CLI.
Zapewnia dużą elastyczność w definiowaniu kolorów i stylów tekstu. Nie można jednak używać kredy w izolacji do tworzenia narzędzi CLI; musisz go używać z pakietami takimi jak Commander i Inquirer.js.
Aby zainstalować Chalk jako zależność, uruchom to polecenie:
np zainstalować kreda
Oto przykład użycia kredy do dodawania kolorów do danych wyjściowych konsoli:
import kreda z"kreda";konsola.log (kreda.niebieski("Witaj świecie!"));
konsola.dziennik(kreda.czerwony.pogrubiony("Ostrzeżenie"));
konsola.dziennik(kreda.biały.italski("powodzenie"));
konsola.dziennik(
kreda.żółty.bgBlue("TentekstmaAżółtypierwszoplanowyIniebieskitło")
);
Kreda zapewnia wiele innych metod definiowania kolorów i stylów, w tym podkreślać, przekreślenie, różne odcienie kolorów tła i wiele innych.
Kreda nie obsługuje systemu modułów CommonJS. Musisz użyć systemu modułów ES6 lub obniżyć pakiet do wersji 4.0.0.
Chalk to świetny pakiet, który sprawi, że narzędzia CLI będą bardziej atrakcyjne wizualnie i czytelne. Ponadto możesz łatwo zintegrować go z istniejącym kodem bez skomplikowanej konfiguracji.
Node Spinner to pakiet Node.js, który zapewnia prosty sposób wyświetlania animacji pokrętła w narzędziach CLI. Możesz użyć tego pakietu, aby wskazać, że długotrwały proces jest w toku, i dać użytkownikowi wizualną wskazówkę, że narzędzie nadal działa.
Aby zainstalować Node Spinner jako zależność, uruchom to polecenie:
np zainstalować cli-spinner
Oto przykład użycia Node Spinner do wyświetlenia animacji pokrętła:
konst Przędzarka = wymagać("cli-spinner").Prządka;konst przędzarka = nowy Prządka("przetwarzanie... %S");
spinner.setSpinnerString("|/-\\\\");
prządka.początek();setTimeout(() => {
spinner.tekst = "Zadanie ukończone.";
setTimeout(() => {
prządka.zatrzymywać się();
}, 500);
}, 5000);
Ten kod używa biblioteki do wyświetlania pokrętła do momentu zakończenia procesu. Kod symuluje operację trwającą 5 sekund przy użyciu ustawiony limit czasu. Pod koniec czasu zmienia wyświetlany tekst z „przetwarzanie...” na „Zadanie zakończone”. i zatrzymuje przędzarkę 0,5 sekundy później.
Node Spinner zapewnia szereg opcji dostosowywania, takich jak zmiana stylów i tekstu pokrętła. Obsługuje również wiele pokręteł, umożliwiając wyświetlanie różnych animacji dla różnych części narzędzia CLI.
Figlet to pakiet Node.js, który zapewnia prosty sposób utwórz grafikę ASCII z tekstu.
Aby zainstalować figlet jako zależność, uruchom to polecenie:
np zainstalować figlet
Oto przykład użycia programu figlet do wygenerowania grafiki ASCII:
konst figlet = wymagać("figlet");figlet("Witaj świecie!!", (błąd, dane) => {
jeśli (błąd) {
konsola.dziennik("Przepraszam, coś poszło nie tak");
konsola.dir (błąd);
powrót;
}
konsola.log (dane);
});
Powyższy przykład tworzy grafikę ASCII z napisem „Hello World!!” za pomocą programu Figlet i loguje go do konsoli.
Uruchomienie tego przykładu powinno dać następujący wynik:
Figlet udostępnia wiele stylów czcionek, których można użyć do dostosowania wyglądu grafiki ASCII. Możesz określić styl czcionki, przekazując obiekt opcji do metody figlet funkcjonować.
Na przykład:
figlet("Witaj świecie!!", { czcionka: "Dzwonek" }, (błąd, dane) => {})
Korzystanie z narzędzia Figlet w narzędziu CLI zwiększa atrakcyjność wizualną narzędzi i czyni je bardziej atrakcyjnymi dla użytkowników.
Wybierając pakiety dla swojego narzędzia CLI, musisz wziąć pod uwagę swoje potrzeby i wybrać pakiety, które zapewniają funkcjonalność, styl i kompatybilność, które je spełniają.
Ekosystem Node.js udostępnia różne pakiety, które mogą analizować argumenty wiersza poleceń, tworzyć interfejs wiersza poleceń, wyświetlać stylizowany tekst i wiele więcej. Wykorzystanie odpowiedniej kombinacji umożliwi tworzenie narzędzi CLI, które są zarówno wysoce funkcjonalne, jak i przyjazne dla użytkownika.