Der Node Package Manager, allgemein bekannt als npm, ist ein Online-Repository zum Veröffentlichen von NodeJS-Paketen und -Bibliotheken.
Es ist auch ein Befehlszeilentool, mit dem Sie mit registrierten Paketen interagieren können. Es kann bei der Paketinstallation, Versionsverwaltung und Abhängigkeitsverwaltung helfen.
Entwickler veröffentlichen ihre JavaScript-Bibliotheken jeden Tag auf npm. Der Prozess ist ziemlich einfach, sodass auch Sie ein Paket auf npm veröffentlichen können.
Schritt 1: Installation von NodeJS
Um mit npm zu interagieren, muss es global auf Ihrem System installiert sein.
Beginnen Sie mit Installation von NodeJS und npm auf Ubuntu, unter Windows, oder befolgen Sie die Anweisungen auf der NodeJS Webseite.
Schritt 2: Erstellen eines npm-Kontos
Um Ihre Pakete auf npm zu veröffentlichen, müssen Sie ein npm-Konto auf der offiziellen npm-Website erstellen.
Führen Sie die folgenden Schritte aus, um ein npm-Konto zu erstellen:
- Gehen Sie zum npm-Anmeldung Seite.
- Geben Sie Ihre Daten ein, stimmen Sie der Lizenz- und Datenschutzrichtlinie zu und klicken Sie auf „Konto erstellen“.
- Bestätigen Sie Ihre E-Mail mit dem Link, den Sie von npm in Ihrem Postfach erhalten.
Wenn Sie Ihre E-Mail-Adresse nicht bestätigen, gibt npm einen Fehler aus, wenn Sie versuchen, Ihre Pakete zu veröffentlichen.
Schritt 3: Initialisieren eines Git-Repositorys
Als Nächstes müssen Sie ein Git-Repository initialisieren, um alle Änderungen zu verfolgen, die Sie an Ihrem Projekt vornehmen werden.
Navigieren Sie auf Ihrem Terminal zum Stammverzeichnis Ihres Projekts und führen Sie den folgenden Befehl aus, um ein leeres Git-Repository zu initialisieren.
git init
Ein... kreieren .gitignorieren Datei und fügen Sie alle Dateien hinzu, die Git nicht nachverfolgen soll. Führen Sie dann den folgenden Befehl aus, um die verbleibenden Dateien zu verfolgen:
git füge -A hinzu
Führen Sie als Nächstes den folgenden Befehl aus, um Ihren ersten Snapshot zu erstellen, indem Sie den Code an Git übergeben.
git verpflichten -m Initial-verpflichten
Sie können wählen Hosten Sie Ihr Git-Repository auf GitHub oder ein ähnlicher Dienst wie Gitlab für eine reibungslose Zusammenarbeit.
Schritt 4: Initialisieren von npm in Ihrem Projekt
Als nächstes initialisieren Sie npm in Ihrem Projekt, um Details zu Ihrem Projekt zu einer package.json-Datei hinzuzufügen. Diese Details werden auf npm veröffentlicht.
Navigieren Sie auf Ihrem Terminal zum Stammverzeichnis Ihres Projekts und führen Sie den folgenden Befehl aus, um npm in Ihrem Projekt zu initialisieren.
npm-Init
Der obige Befehl löst eine Reihe von Eingabeaufforderungen in Ihrer Befehlszeile aus:
- Paketnamen: Dies ist der Name Ihres npm-Pakets; es muss eindeutig sein, wenn Sie das Paket auf npm veröffentlichen möchten; Andernfalls gibt npm einen Fehler aus.
- Ausführung: Diese Eigenschaft gibt die aktuelle Version Ihres Pakets an. Sie müssen es jedes Mal erhöhen, wenn Sie Ihr Paket aktualisieren, oder npm gibt einen Fehler aus. Der Standardwert ist 1.0.0.
- Bezeichnung: Diese Eigenschaft ist die Beschreibung Ihres Pakets. Es wird öffentlich, wenn Sie Ihr Paket veröffentlichen.
- Einstiegspunkt: Diese Eigenschaft gibt den Dateinamen an, an dem Ihre Codeausführung beginnt.
- Testbefehl: Diese Eigenschaft gibt den Befehl an, der ausgeführt wird, wenn Sie ihn ausführen npm-Test ausführen.
- Git-Repository: Diese Eigenschaft ist die URL für Ihr Remote-Git-Repository.
- Schlüsselwörter: Diese Eigenschaft bezeichnet die relevanten Schlüsselwörter für Ihr Projekt, die der Suchmaschine helfen, es zu finden.
- Autor: Diese Eigenschaft sollte Ihr Name oder Alias sein.
- Lizenz: Dies ist die Lizenz, unter der Sie das Paket veröffentlichen möchten. Die Standardlizenz ist die Internet Systems Consortium (ISC)-Lizenz.
Nachdem Sie dies eingerichtet haben, können Sie Ihr Paket erstellen.
Schritt 5: Testen Sie Ihr Paket
Nachdem Sie Ihr Paket erstellt haben, sollten Sie es lokal testen, um zu sehen, wie es sich verhalten würde, nachdem Sie es auf npm bereitgestellt haben.
Um Ihr Paket lokal zu testen, führen Sie zunächst den folgenden Befehl im Verzeichnis Ihres Projekts aus:
npm-Link
Mit dem obigen Befehl können Sie Ihr Paket lokal referenzieren, wie Sie es bei einem von npm gehosteten Paket tun würden.
Erstellen Sie dann einen weiteren Ordner im Stammverzeichnis Ihres Projekts und cd hinein.
mkdir Prüfung
CDPrüfung
Führen Sie im Testordner den folgenden Befehl aus, um Ihr Paket mit dem Ordner zu verknüpfen:
npm link name-of-your-Paket
Erstellen Sie abschließend eine Dummy-Datei, um die Funktionalität Ihres Pakets zu testen.
Nach Abschluss Ihrer Tests können Sie Ihren Testordner sicher löschen.
Schritt 6: Anmelden bei npm auf Ihrem System
Als nächstes müssen Sie sich bei Ihrem npm-Konto auf Ihrem System anmelden.
Führen Sie den folgenden Befehl aus, um sich bei Ihrem npm-Konto anzumelden:
npm-Anmeldung
Dies fordert Sie auf, Ihren Benutzernamen, Ihr Passwort und einen Zwei-Faktor-Authentifizierungscode einzugeben (falls Sie ihn für Ihr Konto aktiviert haben).
Schritt 7: Veröffentlichen Sie Ihr Paket
Nachdem Sie alle oben genannten Schritte ausgeführt haben, führen Sie den folgenden Befehl aus, um Ihr Paket auf npm zu veröffentlichen.
npm veröffentlichen
Dieser Befehl erfordert ein einmaliges Passwort, das an Ihre E-Mail gesendet wird. Dann wird Ihr Paket auf npm veröffentlicht.
Sie können die Pakete anzeigen, die Sie auf npm veröffentlicht haben. Melden Sie sich bei Ihrem npm-Konto an npmjs.com und navigieren Sie in Ihrem Profil-Dashboard zum Paketabschnitt.
Führen Sie Folgendes aus, um Ihr Paket zu installieren und als Abhängigkeit von einem Ihrer Projekte zu verwenden:
npm InstallierenName-von-dein-Paket
Löschen Ihres Pakets aus npm
Sie haben immer noch die vollständige Kontrolle über Ihre Pakete auf npm, was bedeutet, dass Sie Ihr Paket ändern und sogar dauerhaft aus npm löschen können. Sie können Ihre Pakete löschen, indem Sie zum Abschnitt Einstellungen Ihres Pakets gehen und die Option Paket löschen auswählen.