Podręcznik

Node Package Manager

Inicjalizacja npm

Aby zainicjalizować obsługę pakietów dla danego projektu, należy otworzyć wiersz poleceń w folderze odpowiadającym temu projektowi, a następnie wpisać polecenie:

    > npm init

Polecenie to skutkuje wykonaniem pewnych czynności, dzięki którym bieżący projekt przybierze postać nowego pakietu (w szczególności – zostanie stworzony plik package.json, opisujący ten nowy pakiet). W rezultacie, po pierwsze, będzie można importować i wykorzystywać inne pakiety za pomocą npm; po drugie, w przyszłości będzie można ten nowo utworzony pakiet udostępnić za pomocą npm.

Po wywołaniu polecenia npm init, oprogramowanie npm zada szereg pytań dotyczących nowo powstałego pakietu, w szczególności:

o nazwę – domyślnie: nazwa bieżącego folderu;
o wersję – domyślnie: 1.0.0;
o plik entry point, czyli „główny” moduł, który zostanie zaimportowany, gdy ten pakiet zostanie w przyszłości wczytany za pomocą polecenia require – domyślnie: index.js, jeśli taki plik istnieje;
o licencję – domyślnie: licencja Internet Systems Consortium (ISC).

a także o inne informacje, których podanie nie jest konieczne, jak m.in.:

opis,
repozytorium git,
słowa kluczowe,
autor.

Aby uniknąć odpowiadania na wyżej wymienione pytania i przyjąć wszystkie domyślne wartości, można skorzystać z opcji --yes:

    > npm init --yes

albo krócej:

    > npm init -y

Plik package.json

Plik package.json zawiera różne informacje, potrzebne do działania npm, w szczególności: informacje o bieżącym pakiecie oraz listę wszystkich pakietów, które są w nim wykorzystywane. W wielu sytuacjach plik package.json jest zarówno odczytywany, jak i modyfikowany automatycznie przez npm. Przykładowa zawartość pliku package.json:

    {

      "name": "my_package",

      "version": "1.0.0",

      "private": true,

      "scripts": {

        "start": "node ./bin/www"

      },

      "dependencies": {

        "cookie-parser": "~1.4.4",

        "debug": "~2.6.9",

        "express": "~4.16.1",

        "http-errors": "~1.6.3",

        "morgan": "~1.9.1",

        "pug": "2.0.0-beta11"

      }

    }