Lägga till paket i Node.js-projektet

  • 11 minuter

Node.js har inbyggda paket för uppgifter som filhantering och HTTP-hantering. Men det finns också en stor mängd paket från tredje part som erbjuds i NPM-registret.

När och hur du väljer ett npm-paket

Som ny utvecklare på Tailwind Traders måste du lägga till funktioner i ett projekt. Du kan skriva koden själv, men du bestämmer dig för att använda ett befintligt paket. Det här utvecklingsbeslutet är ett vanligt scenario.

När ska du använda ett befintligt paket? Här följer några faktorer att tänka på:

  • Kvalitet: För uppgifter som säkerhet säkerställer användning av väletablerade paket att du följer bästa praxis och hanterar gränsfall.
  • Effektivitet: Det tar tid att skriva din egen kod. Om du använder befintliga paket kan du spara mycket arbete.
  • Underhåll: Bibliotek behöver uppdateringar och felkorrigeringar. Det är ofta mer effektivt att låta ett team med öppen källkod hantera detta.

Utvecklare kan hitta och ladda ned paket från olika källor, till exempel:

  • Register: Register är samlingar av paket, till exempel npm-registret. Du kan också vara värd för ditt eget register.
  • Lagringsplatser: Du kan installera paket direkt från en GitHub-URL.
  • Filer: Paket kan installeras från en lokal mapp eller zippad fil, vilket är användbart för att testa dina egna paket.
  • Kataloger: Du kan också installera direkt från en katalog.

När du har valt ett paket kontrollerar du dess beroenden för att ta hänsyn till följande faktorer:

  • Storlek: Fler beroenden innebär ett större fotavtryck. Fotavtrycksstorleken är viktig om du har bandbredds- eller maskinvarubegränsningar. Kom ihåg att installation av ett paket även installerar dess beroenden. Detta kan resultera i en stor node_modules mapp.
  • Popularitet: Ett pakets popularitet kan indikera dess kvalitet.
  • Licensiering: Om du planerar att sälja programvaran kontrollerar du att alla beroendepaketlicenser tillåter återanvändning och vidareförsäljning.
  • Aktivt underhåll: Undvik beroenden som är inaktuella eller sällan uppdaterade.

Mer information om ett paket finns på deras paketsida på NPM och deras GitHub-lagringsplats. Du kan också använda kommandot npm: npm view <package name>.

Installera ett paket

Om du vill installera ett paket använder du npm CLI installerat med Node.js. Du kan lägga till ett paket i node.js-projektet med npm install kommandot i terminalen.

npm install <name of package>

När du kör install kommandot ansluter kommandoradsverktyget till ett globalt register, hämtar koden och placerar den i en node_modules mapp i roten av projektet.

Några vanliga växlar för installationskommandot är:

  • För paket med endast utveckling använder du --save-dev. Den här växeln sparar i devDependencies egenskapen package.json. Dessa beroenden är vanligtvis format, lint, build, transpile och testverktyg.
  • För endast produktionspaket använder du --production. Den här växeln exkluderar endast utvecklingspaket.
  • För globalt tillgängliga verktyg använder du -g. Kommandoradsverktyg installeras ofta globalt i stället för att importeras till projekt. Globala beroenden installeras i en systemomfattande katalog, inte på proejct-nivån node_modules. Globala paket kan dock göra systemet rörigt. Kommandot npx löser detta genom att tillfälligt installera paket. Använd npx <name> för att hämta ett paket, köra det och sedan ta bort det.

Efter installationen ser projektkatalogen ut som i följande exempel:

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

npm CLI-kommandon

Kommandoradsverktyget npm har en hel del kommandon som hjälper dig med uppgifter som att installera paket, redigera paket och initiera Node.js-projekt.

NPM-kommandon delas in i kategorier:

  • Hantera beroenden: Kommandon för att installera, uppdatera och ta bort paket.
  • Kör skript: Kommandon för att hantera utvecklingsflöden som testning och byggkod.
  • Konfigurera miljö: Kommandon för att konfigurera installationssökvägar och paketkällor.
  • Skapa och publicera paket: Kommandon för att skapa och publicera paket.

Om du vill ha en detaljerad lista över alla kommandon anger du följande kommando i terminalen:

npm --help

Kontrollera installation

Om du vill se vad som finns i mappen package.json använder du npm list. Kommandot npm list visar alla paket i katalogen node_modules som har installerats. Varje installerat paket installerade alla sina egna beroenden.

list Eftersom kommandot kan resultera i en lång lista, vilket gör det svårt att förstå, kan du lista paket på olika djup med listkommandot. Vid djup 0 visar kommandot samma innehåll som du har i avsnittet dependencies i package.json.

npm list --depth=<depth>

Om du har installerat Jest-paketet npm list --depth=0 genererar utdata som liknar dessa utdata:

├── jest@26.0.1

Rensa beroenden

Om du inte längre behöver ett paket tar du bort det. Om du tar bort ett beroende är projektet rent och sparar utrymme. Den här rensningen är särskilt viktig för ensidesprogram (SPA) som Angular, React eller Vue. Dessa appar paketar och komprimerar kod till en fil som hanteras i webbläsaren. Ju större filen är, desto längre tid tar det att läsa in, vilket kan avskräcka användare.

Det finns två sätt att rensa bort beroenden som du inte längre behöver:

  • Avinstallera: Om du vill avinstallera ett paket kör du npm uninstall <name of dependency>. Det här kommandot tar bort paketet från package.json manifestfilen och från mappen node_modules.
  • Prune: Använd npm prune för att ta bort alla olistade beroenden från node_modules. Beskärning är användbart när du vill ta bort flera beroenden utan att köra avinstallationen för var och en. Så här beskär du:
    1. Ta bort posterna från beroenden eller devDependencies i package.json.
    2. run npm prune.