Ustawienia pliku package.json w JavaScript
Gdy jakiś programista chce udostępnić
swoją bibliotekę wszystkim chętnym,
musi umieścić ją w rejestrze
(czyli w repozytorium) npm. W tym celu musi
odpowiednio przygotować plik package.json
tej biblioteki, dodając kilka
ważnych ustawień.
Ustawienia te dotyczą właśnie publicznych bibliotek, które pobierasz z npm. W swoich projektach do użytku prywatnego nie musisz ich ustawiać.
Oto lista najpopularniejszych ustawień:
| Wartość | Opis |
|---|---|
name |
nazwa projektu, powinna być zapisana małymi literami |
version |
numer wersji, zgodnie z semantycznym wersjonowaniem |
description |
opis projektu |
main |
pliku wejściowy projektu |
keywords |
to tablica, pomagająca znaleźć moduł w rejestrze npm |
author |
to pole przyjmuje obiekt z kluczami name, email i url,
co pozwala ludziom łatwo skontaktować się z autorem projektu.
|
license |
przyjmuje nazwę licencji przy użyciu identyfikatora SPDX. Domyślnie stosowana jest licencja ISC, kolejny popularny wybór to MIT. Możesz również użyć UNLICENSED dla projektów prywatnych i projektów zamkniętych. |
private |
jeśli dla tego klucza ustawiona jest wartość true, projekt nie może być publiczny w rejestrze npm. Pozwala to zapobiec przypadkowej publikacji projektu. |
homepage |
adres URL strony głównej projektu |
bugs |
adres URL, pod którym można zgłaszać problemy i błędy. Często jest to adres strony projektu na Github. |
Zainstaluj bibliotekę jQuery.
Znajdź w node_modules folder z biblioteką,
a w nim - plik package.json. Przeanalizuj go.
Zainstaluj bibliotekę underscorejs.
Znajdź w node_modules folder z biblioteką,
a w nim - plik package.json. Przeanalizuj go.
Zapoznaj się z ustawieniami pliku package.json
w oficjalnej dokumentacji.