Opprette og publisere private pakker

hvis du vil dele koden din med et begrenset sett med brukere eller grupper, kan du publisere private brukeromfang eller organisasjonsomfang pakker til npm-registeret.

for mer informasjon om omfang og private pakker, se “om omfang” og “om private pakker”.

Opprette en privat pakke

1. hvis du bruker npmrc til å administrere kontoer på flere registre, på kommandolinjen, bytt til riktig profil:

   npmrc <profilnavn>

2. opprett en katalog for pakken din på kommandolinjen:

   mkdir my-test-pakke

3. Naviger til rotkatalogen på pakken din:

   cd my-test-package

4. hvis du bruker git til å administrere pakkekoden, kjører du følgende kommandoer i pakkens rotkatalog, og erstatter git-remote-url med git remote url for pakken din:

   git init
   git remote legg til opprinnelse git://git-remote-url

5. i pakken rotkatalogen, kjør npm init kommandoen og sende omfanget til scope flagget:

   • for en organisasjon-scoped pakke, erstatte my-org med navnet på organisasjonen:

     npm init [email protected]

   • for en pakke med brukeromfang, erstatt my-username med ditt brukernavn:

     npm init [email protected]

8. svar på instruksjonene for å generere en package.json fil. Hvis du vil ha hjelp til å navngi pakken, kan du se “Retningslinjer For Pakkenavn”.

9. Opprett EN README-fil som forklarer hva pakkekoden din er og hvordan du bruker den.

10. skriv koden for pakken din i din foretrukne tekstredigerer.

Gjennomgang av pakkeinnhold for sensitiv eller unødvendig informasjon

Publisering av sensitiv informasjon til registret kan skade brukerne, kompromittere utviklingsinfrastrukturen, være dyrt å fikse og sette deg i fare for rettslige skritt. Vi anbefaler på det sterkeste å fjerne sensitiv informasjon, for eksempel private nøkler, passord, (PII) og kredittkortdata før du publiserer pakken til registret. Selv om pakken din er privat, kan sensitiv informasjon bli avslørt hvis pakken blir offentliggjort eller lastet ned til en datamaskin som kan nås av flere brukere enn beregnet.

hvis du vil ha mindre sensitiv informasjon, for eksempel testdata, kan du bruke en.npmignore eller.gitignore – fil for å forhindre publisering til registret. For mer informasjon, se denne artikkelen.

Teste pakken

for å redusere sjansene for å publisere feil, anbefaler vi at du tester pakken før du publiserer den til npm-registeret. For å teste pakken din, kjør npm install med hele banen til pakkekatalogen din:

npm installer min-pakke