Wszystkie pakiety npm zawierają plik, zwykle w katalogu głównym projektu, o nazwie package.json — ten plik zawiera różne metadane istotne dla projektu. Plik ten służy do przekazywania informacji npm, które pozwalają mu zidentyfikować projekt, a także obsłużyć zależności projektu. Może również zawierać inne metadane, takie jak opis projektu, wersję projektu, informacje licencyjne, a nawet dane konfiguracyjne - wszystko to może być istotne zarówno dla npm, jak i końcowych użytkowników pakietu. Plik package.json zwykle znajduje się w katalogu głównym projektu Node.js.
Oto minimalny pakiet.json:
Pole nazwy: jest to nazwa twojego projektu. Pole wersji jest używane przez npm, aby upewnić się, że instalowana jest właściwa wersja pakietu. Ogólnie rzecz biorąc, przybiera ona postać major.minor.patch, gdzie major, minor i patch są liczbami całkowitymi, które zwiększają się po każdym nowym wydaniu.
Bardziej kompletny package.json:
Jak widzisz, są pola na opis i słowa kluczowe Twoich projektów. Dzięki temu osoby, które znalazły Twój projekt, mogą zrozumieć, o czym on jest. Autor, współtwórcy, strona główna i pola repozytorium mogą być wykorzystane do opisania osób, które przyczyniły się do projektu, pokazania, jak skontaktować się z autorem/opiekunem i podać linki do dodatkowych referencji.
Na koniec pole zależności, służy do wyświetlania wszystkich zależności projektu, które są dostępne w npm. Gdy ktoś zainstaluje Twój projekt za pośrednictwem npm, wszystkie wymienione zależności zostaną również zainstalowane. Dodatkowo, jeśli ktoś uruchomi npm install w katalogu głównym twojego projektu, zainstaluje wszystkie zależności w ./node_modules.
Możliwe jest również dodanie pola devDependencies do twojego package.json - są to zależności niewymagane do normalnego działania, ale wymagane/zalecane, jeśli chcesz załatać lub zmodyfikować projekt. Jeśli na przykład zbudowałeś testy jednostkowe przy użyciu platformy testowej, odpowiednie byłoby umieszczenie używanej platformy testowej w polu devDependencies. Aby zainstalować devDependencies projektu, po prostu przekaż opcję --dev podczas korzystania z instalacji npm.