Skrypty npm zawierają zestaw poleceń terminala, których można użyć do automatyzacji zadań w projekcie JavaScript. Zapewniają również spójny sposób uruchamiania poleceń w różnych środowiskach.
Możesz skonfigurować skrypty npm w pliku package.json, uruchamiać je w wierszu poleceń i używać szerokiego zestawu opcji do konfigurowania ich zachowania.
Konfigurowanie skryptów npm w pliku package.json
Skrypty npm są zwykle definiowane w pliku package.json znajdującym się w katalogu głównym projektu JavaScript. Nie jest to konieczne, ponieważ możesz wykonywać skrypty z innych plików, ale pakiet.json ułatwia dostęp do skryptów i zarządzanie nimi.
Pamiętaj, że aby śledzić, musisz mieć zainstalowane npm i Node w swoim środowisku programistycznym. Oto kilka pomocnych artykułów:
- Jak zainstaluj Node.js i npm w systemie Windows.
- Jak zainstaluj Node.js i npm na Ubuntu.
Aby skonfigurować skrypt npm w pliku package.json, wykonaj poniższe czynności:
- Przejdź do katalogu głównego swojego projektu.
- Uruchom npm init na terminalu. Polecenie zada ci kilka pytań dotyczących twojego projektu. Odpowiedz na nie, aby utworzyć odpowiedni plik package.json.
npm init - W pliku package.json zlokalizuj pole scripts. Tutaj możesz dodać nazwę skryptu i polecenie, które powinien uruchomić jako pary klucz/wartość. Na przykład poniższy skrypt o nazwie hello-world po uruchomieniu wyświetla w terminalu komunikat „Hello world”.
{
„skrypty”: {
"Witaj świecie": "Echo \\"Witaj świecie\\""
}
}
Oto kilka typowych skryptów dla projektów JavaScript:
- początek: Ten skrypt uruchamia serwer deweloperski. Na przykład w projekcie Node może uruchom serwer za pomocą nodemon.
- zbudować: Generuje kod produkcyjny Twojej aplikacji i może użyć narzędzia takiego jak webpack do zminimalizowania i spakowania kodu.
- test: Ten skrypt uruchamia testy zdefiniowane w Twoim projekcie. Może uruchamiać platformę testową, taką jak Jest.
- szarpie: Skrypt lint uruchamia narzędzie linting, takie jak ESLint, aby sprawdzić kod pod kątem potencjalnych błędów.
- oglądać: Ten skrypt obserwuje kod źródłowy pod kątem zmian, a następnie uruchamia polecenie. Jest to przydatne do ponownego uruchamiania testów lub przebudowywania aplikacji po zmianie kodu.
- wdrożyć: uruchamia polecenie, które wdraża aplikację w określonym środowisku, takim jak produkcja lub przemieszczanie.
Skrypty przed i po
npm obsługuje skrypty przed i po. Skrypty wstępne są uruchamiane przed określonym skryptem, podczas gdy skrypty końcowe są uruchamiane później. Skrypty wstępne i końcowe można tworzyć dla dowolnego skryptu, wystarczy poprzedzić nazwę skryptu przedrostkiem „pre” lub „post”.
Na przykład poniżej znajdują się skrypty pretestu i posttestu, które zostaną uruchomione odpowiednio przed i po skrypcie testowym.
{
„skrypty”: {
„pretest”: „npm run lint”,
"test": "żart",
„posttest”: „npm run build”
}
}
Uruchamianie skryptów npm z pliku package.json
Po dodaniu skryptu npm do pliku package.json możesz go uruchomić za pomocą polecenia npmrun.
Oto składnia:
bieg npm
Na przykład, aby uruchomić zdefiniowany wcześniej skrypt startowy, użyj:
start biegu npm
Możesz samodzielnie wykonać polecenie npmrun, aby uzyskać listę wszystkich dostępnych skryptów w projekcie. Oto przykładowe dane wyjściowe:
Skrypty dostępne w [email protected] przez `npm run-script`:
Witaj świecie
echo "Witaj świecie"
Zawiera nazwę skryptu i polecenie, które uruchamia.
Używanie skróconych poleceń do uruchamiania wbudowanych skryptów
npm obsługuje kilka wbudowanych skryptów, które można uruchamiać za pomocą skróconych poleceń. Na przykład, aby uruchomić skrypt npm o nazwie start, możesz użyć npm start zamiast npm run start.
Jest to wygodniejsze i szybsze niż wpisywanie całego polecenia. Inne wbudowane skrypty, które możesz uruchomić w ten sposób, to „test”, „zatrzymaj” i „uruchom ponownie”.
Uruchamianie wielu skryptów npm
Możesz uruchomić wiele skryptów npm na dwa sposoby:
- Po kolei
- Równolegle
Jeśli używasz Linuksa lub innego systemu podobnego do Uniksa, możesz użyć standardu metody uruchamiania wielu poleceń jednocześnie.
Aby uruchomić wiele skryptów npm po kolei, użyj &&, na przykład:
npm uruchom uruchom && npm test
Aby uruchomić wiele skryptów npm równolegle, użyj &, na przykład:
npm uruchom serwer i npm uruchom klienta
W środowiskach innych niż UNIX można użyć polecenia npm-run-all lub pakietu concurrently npm.
Używanie npm-run-all:
npm-run-all --równoległy klient serwera
Używanie jednocześnie w package.json.
„skrypty”: {
„deweloper”: "równocześnie \\"serwer uruchamiania npm\\" \\"npm uruchom klienta\\"",
}
Pamiętaj, że musisz zainstalować pakiety npm-run-all i Concurrently przed ich użyciem.
Rozwiązywanie typowych błędów skryptów Npm
Poniżej znajduje się kilka typowych błędów, które możesz napotkać podczas uruchamiania skryptów npm:
- np błąd! brak skryptu — Ten błąd występuje, gdy nie zdefiniowałeś skryptu, który próbujesz uruchomić w pliku package.json. Upewnij się, że nazwa skryptu została wpisana poprawnie i że jest zdefiniowana w polu scripts w pliku package.json.
- Odmowa pozwolenia — Ten błąd występuje, gdy nie masz uprawnień do uruchomienia skryptu, więc upewnij się, że masz odpowiednie uprawnienia.
- Brakujące zależności — Ten błąd występuje, gdy skrypt używa pakietu, który nie jest zainstalowany. Użyj narzędzia takiego jak Depcheck aby sprawdzić brakujące zależności w package.json, a następnie zainstaluj je za pomocą npm install.
- Nieznane polecenie — Ten błąd zwykle występuje, gdy uruchamiasz niestandardowy skrypt jako wbudowane polecenie npm. Upewnij się, że używasz bieg npm Lub skrypt uruchamiania npm podczas uruchamiania niestandardowych skryptów.
Używanie zmiennych środowiskowych w skryptach npm
Zmienne środowiska umożliwiają przekazywanie informacji bez kodowania ich na stałe. Aby użyć zmiennych środowiskowych w skrypcie npm, możesz użyć metody pakiet npm z różnymi środowiskami. To narzędzie pomaga ustawić zmienną środowiskową w dowolnym środowisku.
Rozpocznij od uruchomienia tego polecenia na terminalu, aby zainstalować je jako zależność dev:
npm zapisuję -D cross-env
Następnie użyj go w swoim skrypcie w następujący sposób:
{
„skrypty”: {
"zbudować": „wielośrodowiskowy NODE_ENV=produkcyjny pakiet internetowy”
}
}
Tutaj cross-env ustawia zmienną NODE_ENV na „production”.
Przekazywanie argumentów wiersza poleceń do skryptów
Możesz przekazać argumenty wiersza poleceń do skryptu npm, używając dwóch kresek „--” po nazwie skryptu. Na przykład następujące polecenie uruchamia skrypt testowy z argumentem watch:
npm uruchom test -- --watch
Możesz także wysłać argument wiersza poleceń do skryptu npm w następujący sposób:
npm uruchom mój port --PORT=3000
Następnie uzyskaj do niego dostęp w skrypcie w następujący sposób.
„skrypty”: {
"mój-port": "Echo \\"Port: $npm_config_PORT\\""
}
W systemie Windows użyj tego:
„skrypty”: {
"mój-port": "Echo \\"Port: %npm_config_PORT%\\""
}
Po uruchomieniu skrypt powinien wyświetlić „Port: 3000”.
Dlaczego warto używać skryptów npm?
Możesz dodawać skrypty do pliku package.json, uruchamiać je w wierszu poleceń, używać haków przed i po oraz przekazywać im argumenty wiersza i zmienne środowiskowe.
Skrypty npm to potężny sposób automatyzacji zadań w projektach JavaScript. Mogą usprawnić przepływ pracy i zaoszczędzić czas, udostępniając spójne polecenia do uruchamiania wielu zadań.