skapa och publicera privata paket

innehållsförteckning

om du vill dela din kod med en begränsad uppsättning användare eller grupper kan du publicera privata användaromfattade eller organisationsomfattade paket till npm-registret.

För mer information om omfattningar och privata paket, se “om omfattningar” och “om privata paket”.

Obs: innan du kan publicera privata npm-paket med användardefinierade paket måste du registrera dig för ett betalt npm-användarkonto.

dessutom måste du skapa ett npm-användarkonto för att publicera paket med privata organisationer och sedan skapa en betald npm-organisation.

skapa ett privat paket

  1. om du använder npmrc för att hantera konton i flera register, byt till lämplig profil på kommandoraden:

    npmrc<profilnamn>

  2. på kommandoraden skapar du en katalog för ditt paket:

    mkdir my-test-package

  3. navigera till rotkatalogen på ditt paket:

    cd my-test-package

  4. om du använder Git för att hantera din paketkod, kör du följande kommandon i paketrotkatalogen och ersätter git-remote-url med git remote URL för ditt paket:

    git init
    git remote Lägg till Ursprung git://git-remote-url

  5. i paketrotkatalogen kör du kommandot npm init och överför räckvidden till scope flagga:

  6. svara på anvisningarna för att generera ettpackage.json fil. För hjälp med att namnge ditt paket, se “Riktlinjer för Paketnamn”.

  7. skapa en README-fil som förklarar vad din paketkod är och hur du använder den.

  8. skriv koden för ditt paket i din önskade textredigerare.

granska Paketets innehåll för känslig eller onödig information

att publicera känslig information till registret kan skada dina användare, äventyra din utvecklingsinfrastruktur, vara dyr att fixa och riskera rättsliga åtgärder. Vi rekommenderar starkt att du tar bort känslig information, till exempel privata nycklar, lösenord, (PII) och kreditkortsdata innan du publicerar ditt paket till registret. Även om ditt paket är privat kan känslig information exponeras om paketet offentliggörs eller laddas ner till en dator som kan nås av fler användare än avsett.

för mindre känslig information, till exempel testdata, använd en .npmignore eller .gitignore – fil för att förhindra publicering i registret. För mer information, se den här artikeln.

Testa ditt paket

för att minska risken för felpublicering rekommenderar vi att du testar ditt paket innan du publicerar det i npm-registret. För att testa ditt paket, kör npm install med hela sökvägen till din paketkatalog:

npm installera my-package

publicera privata paket

som standard publiceras scoped-paket med privat synlighet.

  1. på kommandoraden navigerar du till rotkatalogen i ditt paket.

    cd / path / to / package

  2. för att publicera ditt privata paket till npm-registret, kör:

    npm publish

  3. för att se din privata paketsida, besök https://npmjs.com/package/*package-name, ersätta Paketnamn* med namnet av ditt paket. Privata paket kommer att säga private under paketnamnet på npm-webbplatsen.

För mer information om kommandotpublish, se CLI-dokumentationen.

Lämna ett svar

Din e-postadress kommer inte publiceras.