Nastavení souboru package.json v JavaScriptu
Když nějaký programátor chce učinit
svou knihovnu dostupnou všem zájemcům,
musí ji umístit do registru
(tj. do úložiště) npm. K tomu musí
formátovat soubor package.json této knihovny
zvláštním způsobem, přidáním některých
důležitých nastavení.
Tato nastavení se týkají právě veřejných knihoven, které stahujete z npm. Ve svých projektech pro soukromé použití je nemusíte nastavovat.
Zde je seznam nejoblíbenějších nastavení:
| Hodnota | Popis |
|---|---|
name |
název projektu, musí být napsán malými písmeny |
version |
číslo verze, podle sémantického verzování |
description |
popis projektu |
main |
vstupní soubor projektu |
keywords |
je to pole, pomáhající najít modul v registru npm |
author |
toto pole přijímá objekt s klíči name, email a url,
což umožňuje lidem snadno kontaktovat autora projektu.
|
license |
přijímá název licence s použitím identifikátoru SPDX. Ve výchozím nastavení se používá licence ISC, další oblíbená volba je MIT. Můžete také použít UNLICENSED pro soukromé projekty a projekty s uzavřeným zdrojovým kódem. |
private |
pokud je pro tento klíč nastavena hodnota true, projekt nemůže být veřejný v registru npm. To umožňuje zabránit náhodné publikaci projektu. |
homepage |
URL adresa domovské stránky projektu |
bugs |
URL adresa, na kterou lze nahlásit problémy a chyby. Často je to adresa stránky projektu na Githubu. |
Nainstalujte knihovnu jQuery.
Najděte v node_modules složku s knihovnou,
a v ní - soubor package.json. Prostudujte jej.
Nainstalujte knihovnu underscorejs.
Najděte v node_modules složku s knihovnou,
a v ní - soubor package.json. Prostudujte jej.
Prostudujte nastavení souboru package.json
v oficiální dokumentaci.