Erstellen und Veröffentlichen von privaten Paketen

Inhaltsverzeichnis

Um Ihren Code für eine begrenzte Anzahl von Benutzern oder Teams freizugeben, können Sie private Pakete für Benutzer oder Organisationen in der npm-Registrierung veröffentlichen.

Weitere Informationen zu Bereichen und privaten Paketen finden Sie unter “Über Bereiche” und “Über private Pakete”.

Hinweis: Bevor Sie private npm-Pakete mit Benutzerbereich veröffentlichen können, müssen Sie sich für ein kostenpflichtiges npm-Benutzerkonto anmelden.

Um Pakete mit privatem Organisationsbereich zu veröffentlichen, müssen Sie außerdem ein npm-Benutzerkonto und dann eine kostenpflichtige npm-Organisation erstellen.

Erstellen eines privaten Pakets

  1. Wenn Sie npmrc verwenden, um Konten in mehreren Registern zu verwalten, wechseln Sie in der Befehlszeile zum entsprechenden Profil:

    npmrc<
    Profilname>
  2. Erstellen Sie in der Befehlszeile ein Verzeichnis für Ihr Paket:

    mkdir my-test-package

  3. Navigieren Sie zum Stammverzeichnis Ihres Pakets:

    cd my-test-package

  4. Wenn Sie git verwenden, um Ihren Paketcode zu verwalten, führen Sie im Paketstammverzeichnis die folgenden Befehle aus und ersetzen Sie git-remote-url durch die git-Remote-URL für Ihr Paket:

    git init
    git remote add origin git://git-remote-url

  5. Führen Sie im Paketstammverzeichnis die npm init und übergeben Sie den Bereich an das scope Flag:

    • Ersetzen Sie für ein Paket mit Organisationsbereich my-org durch den Namen Ihrer Organisation:

    • Ersetzen Sie für ein Paket mit Benutzerbereich my-username durch Ihren Benutzernamen:

  6. Antworten Sie auf die Eingabeaufforderungen, um eine package.json -Datei zu generieren. Hilfe zur Benennung Ihres Pakets finden Sie unter “Richtlinien für Paketnamen”.

  7. Erstellen Sie eine README-Datei, die erklärt, was Ihr Paketcode ist und wie er verwendet wird.

  8. Schreiben Sie in Ihrem bevorzugten Texteditor den Code für Ihr Paket.

Überprüfen des Paketinhalts auf vertrauliche oder unnötige Informationen

Das Veröffentlichen vertraulicher Informationen in der Registrierung kann Ihren Benutzern schaden, Ihre Entwicklungsinfrastruktur gefährden, teuer in der Reparatur sein und Sie in Gefahr bringen, rechtliche Schritte einzuleiten. Wir empfehlen dringend, vertrauliche Informationen wie private Schlüssel, Passwörter und Kreditkartendaten zu entfernen, bevor Sie Ihr Paket in der Registrierung veröffentlichen. Selbst wenn Ihr Paket privat ist, können vertrauliche Informationen offengelegt werden, wenn das Paket veröffentlicht oder auf einen Computer heruntergeladen wird, auf den mehr Benutzer als vorgesehen zugreifen können.

Verwenden Sie für weniger sensible Informationen wie Testdaten eine .npmignore oder .gitignore Datei, um die Veröffentlichung in der Registrierung zu verhindern. Weitere Informationen finden Sie in diesem Artikel.

Testen Ihres Pakets

Um die Wahrscheinlichkeit zu verringern, dass Fehler veröffentlicht werden, empfehlen wir, Ihr Paket zu testen, bevor Sie es in der npm-Registrierung veröffentlichen. Um Ihr Paket zu testen, führen Sie npm install mit dem vollständigen Pfad zu Ihrem Paketverzeichnis aus:

npm install my-package

Private Pakete veröffentlichen

pakete werden mit privater Sichtbarkeit veröffentlicht.

  1. Navigieren Sie in der Befehlszeile zum Stammverzeichnis Ihres Pakets.

    cd /path/to/package

  2. Um Ihr privates Paket in der npm-Registrierung zu veröffentlichen, führen Sie:

    npm publish

  3. Um Ihre private Paketseite anzuzeigen, besuchen Sie https://npmjs.com/package/*package-name und ersetzen Sie package-name* durch den Namen Ihres Pakets. Private Pakete sagen private unter dem Paketnamen auf der npm-Website.

Weitere Informationen zum Befehl publish finden Sie in der CLI-Dokumentation.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.