cheatsheets

npm Cheatsheet

https://unpkg.com/ - Korzystanie z paczek bez ich instalacji

Konfiguracja narzędzia npm

npm set init-author-name "Piotr Kowalski"
npm set init-author-email "[email protected]"
npm set init-author-url "https://piecioshka.pl"
npm set init-license "MIT"
npm set init-version "1.0.0"

Stworzenie pliku package.json

npm init

# Udzielając domyślnej odpowiedzi na wszystkie pytania
npm init -y
# lub
npm init -f

Instalacja paczki

# LOKALNA
npm install NAZWA_PACZKI
npm add NAZWA_PACZKI
npm ci                      # instalacja zależności bez modyfikacji
npm install -D NAZWA_PACZKI
npm add -D NAZWA_PACZKI

# GLOBALNA
npm install -g NAZWA_PACZKI
npm add -g NAZWA_PACZKI

Usunięcie paczki

# LOKALNE
npm uninstall NAZWA_PACZKI
npm remove NAZWA_PACZKI

# GLOBALNA
npm uninstall -g NAZWA_PACZKI
npm remove -g NAZWA_PACZKI

Wyświetlenie zależności (tylko pierwszy poziom)

npm ls -g --depth=0

Uruchomienie zadania z run-scripts

package.json

{
    "scripts": {
        "PRENAZWA_ZDARZENIA": "POLECENIE 1",
        "NAZWA_ZDARZENIA": "POLECENIE 2",
        "POSTNAZWA_ZDARZENIA": "POLECENIE 3"
    }
}

npm run NAZWA_ZDARZENIA

Commands will run:

POLECENIE 1
POLECENIE 2
POLECENIE 3

Zadania run-scripts, które mają skrócą składnię uruchomienia

Commands	Equivalent
npm start	npm run start
npm restart	npm run restart
npm stop	npm run stop
npm test, npm t	npm run test

Uruchomienie audytu

Sprawdzamy czy używamy paczek bez zgłoszonych błędów bezpieczeństwa

npm audit
# Reinstalacja paczek, które mają zgłoszone luki bezpieczeństwa
npm audit fix
# Wymuszenie reinstalacji, nawet kosztem niekompatybilności
npm audit fix --force

Aktualizacja narzędzia npm oraz Node.js

npm install -g npm

Aktualizacja globalnych paczek npm-a

UWAGA: polecenie zawiera również aktualizację samego npm-a.

npm update -g

Wyświetlenie ścieżki do katalogu, gdzie instalują się paczki globalne

npm config get prefix

Wyświetlenie paczek zainstalowanych globalnie (bez ich zależności)

npm ls -g -depth 0

Wyświetlenie adresu URL do rejestru z którego ściągane są paczki

npm config get registry

Wyświetlenie pliku z zapisaną globalną konfiguracją, możliwą do edycji poprzez użytkownika systemu

npm config get userconfig

Wyświetlenie konfiguracji npm-a ustawionej przez użytkownika

npm config list

Wyświetlenie konfiguracji npm-a ze wszystkich możliwych miejsc

npm config ls -l

Wyświetlenie ścieżki do katalogu z cache-em, gdzie będą zapisywane paczki podczas instalowania zależności projektowych, ale także zależności do globalnych poleceń

npm config get cache

Od czasu do czasu można usunąć ten katalog poleceniem:

npm cache clean

Od teraz nie będzie istniała katalog zdefiniowany w konfiguracji:

npm config get cache

Wyświetlenie statystyk jakie generowane są przez narzędzie npm

cat `npm config get cache`/anonymous-cli-metrics.json

Wyświetlony zostanie string w formacie JSON. Aby go sformatować:

cat `npm config get cache`/anonymous-cli-metrics.json | python -m json.tool

Wyświetlić ścieżkę do pliku, który będzie zwracał obiekt JSON wykorzystany jako domyślna konfiguracja polecenie npm init

npm config get init-module

Wyświetlenie ścieżek, gdzie znajdują się programy o konkretnej nazwie

whereis node
# or
where node

Narzędzie whereis przeszukuje katalogi zdefiniowane w zmiennych:

• $PATH
• $MANPATH