Node Package Manager, populärt känd som npm, är ett onlineförråd för publicering av NodeJS-paket och -bibliotek.
Det är också ett kommandoradsverktyg som låter dig interagera med registrerade paket. Det kan hjälpa till med paketinstallation, versionshantering och beroendehantering.
Utvecklare publicerar sina JavaScript-bibliotek på npm varje dag. Processen är ganska enkel, så du kan också publicera ett paket på npm.
Steg 1: Installera NodeJS
För att interagera med npm måste du ha det globalt installerat på ditt system.
Börja med installera NodeJS och npm på Ubuntu, på Windows, eller genom att följa instruktionerna på NodeJS hemsida.
Steg 2: Skapa ett npm-konto
För att publicera dina paket på npm måste du skapa ett npm-konto på den officiella npm-webbplatsen.
Följ stegen nedan för att skapa ett npm-konto:
- Gå till npm registrering sida.
- Fyll i dina uppgifter, godkänn licensen och integritetspolicyn och klicka på "skapa konto".
- Verifiera din e-post med länken du får från npm i din brevlåda.
Om du inte verifierar din e-postadress kommer npm att skicka ett felmeddelande när du försöker publicera dina paket.
Steg 3: Initiera ett Git-förråd
Därefter måste du initiera ett Git-förråd för att spåra alla ändringar du kommer att göra i ditt projekt.
På din terminal, navigera till ditt projekts rotkatalog och kör följande kommando för att initiera ett tomt Git-förråd.
git init
Skapa en .gitignore fil och lägg till alla filer som du inte vill att Git ska spåra. Kör sedan följande kommando för att spåra de återstående filerna:
git add -A
Kör sedan följande kommando för att ta din första ögonblicksbild genom att överföra koden till Git.
git begå -m första-begå
Du kan välja att värd för ditt Git-förråd på GitHub eller en liknande tjänst som Gitlab för smidigt samarbete.
Steg 4: Initiera npm i ditt projekt
Initiera sedan npm i ditt projekt för att lägga till detaljer om ditt projekt till en package.json-fil. Dessa uppgifter kommer att vara offentliga på npm.
På din terminal, navigera till ditt projekts rotkatalog och kör följande kommando för att initiera npm i ditt projekt.
npm init
Kommandot ovan kommer att utlösa en uppsättning uppmaningar på din kommandorad:
- Paketnamn: Detta är namnet på ditt npm-paket; det måste vara unikt om du vill publicera paketet på npm; annars kommer npm att ge ett fel.
- version: Den här egenskapen anger den aktuella versionen av ditt paket. Du måste öka det varje gång du uppdaterar ditt paket annars kommer npm att ge ett fel. Standardvärdet är 1.0.0.
- beskrivning: Den här egenskapen är beskrivningen av ditt paket. Det kommer att vara offentligt när du publicerar ditt paket.
- inkörsport: Den här egenskapen anger filnamnet där din kodexekvering startar.
- testkommando: Den här egenskapen indikerar kommandot som kommer att köras när du kör npm körtest.
- git repository: Den här egenskapen är URL: en för ditt fjärrlager för Git.
- nyckelord: Den här egenskapen anger relevanta nyckelord för ditt projekt som hjälper sökmotorn att hitta det.
- författare: Den här egenskapen ska vara ditt namn eller alias.
- licens: Detta är licensen som du vill publicera paketet under. Standardlicensen är Internet Systems Consortium (ISC)-licensen.
När du har ställt in detta kan du skapa ditt paket.
Steg 5: Testa ditt paket
När du har skapat klart ditt paket bör du testa det lokalt för att se hur det skulle bete sig efter att du har distribuerat det på npm.
För att testa ditt paket lokalt, kör först följande kommando i ditt projekts katalog:
npm länk
Kommandot ovan låter dig referera till ditt paket lokalt på samma sätt som ett npm-hostat paket.
Skapa sedan en annan mapp i ditt projekts rotkatalog och cd in i den.
mkdir testa
CDtesta
Kör följande kommando i testmappen för att länka ditt paket till mappen:
npm-länk namn-på-ditt-paket
Slutligen, skapa en dummy-fil för att testa ditt pakets funktionalitet.
När du har slutfört dina tester kan du säkert ta bort din testmapp.
Steg 6: Logga in på npm på ditt system
Därefter måste du logga in på ditt npm-konto på ditt system.
Kör följande kommando för att logga in på ditt npm-konto:
npm inloggning
Detta kommer att uppmana dig att fylla i ditt användarnamn, lösenord och en tvåfaktorsautentiseringskod (om du har aktiverat det på ditt konto).
Steg 7: Publicera ditt paket
När du har slutfört alla steg ovan, kör följande kommando för att publicera ditt paket på npm.
npm publicera
Detta kommando kräver ett engångslösenord som kommer att vara till din e-post. Sedan kommer den att publicera ditt paket på npm.
Du kan se paketen du har publicerat på npm. Logga in på ditt npm-konto på npmjs.com och navigera till paketsektionen på din profilinstrumentpanel.
För att installera ditt paket och använda det som ett beroende av något av dina projekt, kör:
npm Installeranamn-av-din-paket
Ta bort ditt paket från npm
Du har fortfarande full kontroll över dina paket på npm, vilket innebär att du kan ändra och till och med ta bort ditt paket permanent från npm. Du kan ta bort dina paket genom att gå till inställningssektionen för ditt paket och välja alternativet ta bort paket.