Přidání balíčků do projektu Node.js

  • 11 min

Node.js obsahuje integrované balíčky pro úlohy, jako je správa souborů a zpracování PROTOKOLU HTTP. Existuje ale také obrovské množství balíčků třetích stran nabízených v registru NPM.

Kdy a jak vybrat balíček npm

Jako nový vývojář ve firmě Tailwind Traders musíte do projektu přidat funkce. Kód můžete napsat sami, ale rozhodnete se použít existující balíček. Toto rozhodnutí o vývoji je běžným scénářem.

Kdy byste měli použít existující balíček? Tady je několik faktorů, které je potřeba vzít v úvahu:

  • Kvalita: U úloh, jako je zabezpečení, vám používání dobře zavedených balíčků zajistí, že budete sledovat osvědčené postupy a zpracovávat hraniční případy.
  • Efektivita: Psaní vlastního kódu nějakou dobu trvá. Použití existujících balíčků vám může ušetřit značné úsilí.
  • Údržba: Knihovny potřebují aktualizace a opravy chyb. Často je efektivnější nechat opensourcový tým, aby to zvládl.

Vývojáři můžou najít a stáhnout balíčky z různých zdrojů, jako jsou:

  • Registry: Registry jsou kolekce balíčků, jako je registr npm. Můžete také hostovat vlastní registr.
  • Úložiště: Balíčky můžete nainstalovat přímo z adresy URL GitHubu.
  • Soubory: Balíčky lze nainstalovat z místní složky nebo souboru ZIP, užitečné pro testování vlastních balíčků.
  • Adresáře: Můžete také nainstalovat přímo z adresáře.

Jakmile vyberete balíček, zkontrolujte jeho závislosti a zvažte následující faktory:

  • Velikost: Větší závislosti znamenají větší nároky. Velikost stopy záleží, pokud máte omezení šířky pásma nebo hardwaru. Nezapomeňte, že instalace balíčku také nainstaluje jeho závislosti. Výsledkem může být velká node_modules složka.
  • Popularita: Popularita balíčku může znamenat jeho kvalitu.
  • Licencování: Pokud plánujete prodávat software, ujistěte se, že všechny licence balíčků závislostí umožňují opakované použití a prodej.
  • Aktivní údržba: Vyhněte se závislostem, které jsou zastaralé nebo zřídka aktualizované.

Další informace o balíčku najdete na jeho stránce balíčku na NPM a v úložišti GitHub. Můžete také použít příkaz npm: npm view <package name>.

Jak nainstalovat balíček

Pokud chcete nainstalovat balíček, použijte npm CLI nainstalované s Node.js. Balíček můžete přidat do projektu Node.js pomocí npm install příkazu v terminálu.

npm install <name of package>

Když příkaz spustíte, nástroj příkazového install řádku se připojí k globálnímu registru, načte kód a umístí ho do node_modules složky v kořenovém adresáři projektu.

Mezi běžné přepínače příkazu install patří:

  • Pro balíčky pouze pro vývoj použijte --save-dev. Tento přepínač uloží do devDependencies vlastnosti package.json. Tyto závislosti jsou obvykle formát, lint, build, transpile a testovací nástroje.
  • Pro balíčky pouze v produkčním prostředí použijte --production. Tento přepínač vylučuje balíčky pouze pro vývoj.
  • Pro globálně dostupné nástroje použijte -g. Nástroje příkazového řádku se často instalují globálně místo importu do projektů. Globální závislosti jsou nainstalovány v adresáři pro celý systém, nikoli v proejct-level node_modules. Globální balíčky ale můžou systém zahltit. Příkaz npx to vyřeší dočasně instalací balíčků. Slouží npx <name> k načtení balíčku, jeho spuštění a odebrání.

Po instalaci vypadá adresář projektu jako v následujícím příkladu:

package.json
node_modules/
  <name of dependency>/
    <files included in the dependency>
src
  index.js

příkazy rozhraní příkazového řádku npm

Nástroj příkazového řádku npm obsahuje několik příkazů, které vám pomůžou s úlohami, jako je instalace balíčků, vytváření balíčků a inicializace projektů Node.js.

Příkazy NPM spadají do kategorií:

  • Správa závislostí: Příkazy pro instalaci, aktualizaci a odebírání balíčků
  • Spouštění skriptů: Příkazy pro správu vývojových toků, jako je testování a sestavování kódu.
  • Konfigurace prostředí: Příkazy pro nastavení instalačních cest a zdrojů balíčků
  • Vytváření a publikování balíčků: Příkazy pro vytváření a publikování balíčků.

Pokud chcete podrobný seznam všech příkazů, zadejte do terminálu následující příkaz:

npm --help

Ověření instalace

Pokud chcete zjistit, co je ve složce package.json , použijte npm list. Příkaz npm list zobrazí seznam všech balíčků v node_modules adresáři, který byl nainstalován. Každý nainstalovaný balíček nainstaloval všechny své vlastní závislosti.

list Vzhledem k tomu, že příkaz může vést k dlouhému seznamu, což znesnadňuje pochopení, můžete pomocí příkazu list vypsat balíčky v různých hloubkách. V hloubce příkaz 0 vypíše stejný obsah, jaký máte v oddílu dependencies souboru package.json.

npm list --depth=<depth>

Pokud jste nainstalovali balíček Jest, npm list --depth=0 vytvoří výstup podobný tomuto výstupu:

├── jest@26.0.1

Vyčištění závislostí

Pokud už balíček nepotřebujete, odeberte ho. Odebrání závislosti udržuje projekt čistý a šetří místo. Toto vyčištění je zvlášť důležité pro jednostrákové aplikace (SPA), jako jsou Angular, React nebo Vue. Tyto aplikace seskupují a komprimují kód do souboru, který se obsluhuje v prohlížeči. Čím větší je soubor, tím déle trvá načtení, což může uživatele odradit.

Existují dva způsoby, jak vyčistit závislosti, které už nepotřebujete:

  • Odinstalace: Chcete-li odinstalovat balíček, spusťte příkaz npm uninstall <name of dependency>. Tento příkaz odebere balíček ze souboru manifestu package.json a ze složky node_modules.
  • Vyřadit: Slouží npm prune k odebrání všech nezaregistrovaných závislostí z node_modules. Vyřazení je užitečné, když chcete odebrat více závislostí bez spuštění odinstalace pro každou z nich. Vyříznout:
    1. Odstraňte položky ze závislostí nebo devDependencies v package.json.
    2. run npm prune.