So veröffentlichen Sie ein Paket auf npm: eine Schritt-für-Schritt-Anleitung

Das Veröffentlichen von Paketen auf NPM (Node Package Manager) ist nicht nur eine Möglichkeit, Ihre Arbeit mit anderen Entwicklern zu teilen, sondern auch, um in der Entwickler-Community hervorzustechen. Stellen Sie sich vor, eine wiederverwendbare Lösung zu schaffen, die in verschiedene Projekte auf der ganzen Welt integriert werden kann und anderen Programmierern Zeit und Mühe spart.

In diesem Artikel erfahren Sie Schritt für Schritt, wie Sie Ihr eigenes Paket auf NPM konfigurieren, veröffentlichen und verwalten, um Ihre Beiträge zugänglich zu machen und Ihre Sichtbarkeit als Entwickler zu erhöhen.

Voraussetzungen

Bevor Sie beginnen, stellen Sie sicher, dass Sie Folgendes haben:

• NPM installiert. Sie können es von nodejs.org herunterladen oder NVM (Node Version Manager) verwenden.
• Ein auf npmjs.com erstelltes Konto

Führen Sie die folgenden Befehle im Terminal aus, um zu überprüfen, ob die Installation von Node.js und NPM erfolgreich war.

node -v
npm -v

Wenn die Installation korrekt ist, zeigt das Terminal die jeweilige Version an.
Das Ergebnis wird dem folgenden ähneln:

$ v20.18.0 # node -v
$ 10.8.2 # npm -v

Konfigurieren des Projekts

Erstellen Sie zunächst einen Ordner mit dem gewünschten Namen für das Paket. In meinem Fall habe ich „string-reverser-jm“ gewählt.

mkdir string-reverser-jm # cria a pasta via terminal
cd string-reverser-jm # acessa a pasta via terminal

NPM initialisieren:

npm init

Wenn Sie den obigen Befehl ausführen, stellt Ihnen das Terminal einige Fragen, um die Datei package.json zu erstellen.
Nachfolgend finden Sie eine Erläuterung zu jedem Punkt, den wir ausfüllen müssen.

• Name: Eine eindeutige Kennung für das Paket.
• Version: Semantische Versionierung verwenden, um Änderungen anzuzeigen.
• Beschreibung: Eine kurze Erklärung der Funktionsweise des Pakets.
• main: Die Einstiegspunktdatei, zum Beispiel index.js.
• Schlüsselwörter: Schlüsselwörter zur Kategorisierung, damit andere Entwickler das Paket leichter finden können.
• Autor: Fügen Sie relevante Autorendetails hinzu.
• Lizenz: Die Lizenz definiert, wie der Code von anderen genutzt, verändert und verbreitet werden darf. Die gebräuchlichste Lizenz ist die MIT, die freizügig ist und eine große Nutzungsfreiheit ermöglicht, sofern der ursprüngliche Urheberrechtsvermerk angegeben wird.

Wenn Sie die Fragen beantwortet haben und NPM die Datei ohne diese Informationen erstellt hat, öffnen Sie die erstellte Datei in einem Editor und fügen Sie alles hinzu, was fehlt.

Beispiel:

{
  "name": "string-reverser-jm",
  "version": "1.0.0",
  "description": "A simple utility to reverse strings, useful for demonstrations and small projects.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"No test specified\" && exit 1"
  },
  "author": "Juliana Macedo <contact@starcoders.info> (https://www.starcoders.info)",
  "keywords": [
    "string",
    "reverse",
    "utility"
  ],
  "license": "MIT"
}

Den Code schreiben

Erstellen Sie die Datei index.js im Stammverzeichnis des Projekts.

function reverseString(str) {
  if (typeof str !== "string") {
    throw new TypeError("Expected a string as input");
  }
  return str.split("").reverse().join("");
}

module.exports = reverseString;

Testen des Pakets

Um das Paket vor der Veröffentlichung zu testen, verwenden wir den Befehl npm link

Führen Sie im Paketverzeichnis den Befehl aus:

npm link

Führen Sie in dem Projekt, in dem Sie das Paket testen möchten, den folgenden Befehl aus:

node -v
npm -v

Importieren und verwenden Sie das Paket in Ihrem Testprojekt, um sicherzustellen, dass es funktioniert:

$ v20.18.0 # node -v
$ 10.8.2 # npm -v

Um die erstellten Links zu entfernen, führen Sie einfach den Befehl npm unlink string-reverser-jm im Testprojektverzeichnis und dann npm unlink im Paketverzeichnis aus.

Vorbereiten des Pakets für die Veröffentlichung

Erstellen Sie zunächst ein Git-Repository für das Paket und verknüpfen Sie es mit NPM. Dies erhöht die Transparenz und das Vertrauen durch die Bereitstellung des Quellcodes, erleichtert die Zusammenarbeit und Community-Beiträge und ermöglicht die Automatisierung mit CI/CD für eine effizientere Verwaltung und Wartung.

Um eine Verknüpfung zu NPM herzustellen, kopieren Sie die https-Adresse des Repositorys und fügen Sie sie zu package.json hinzu:

mkdir string-reverser-jm # cria a pasta via terminal
cd string-reverser-jm # acessa a pasta via terminal

• .gitignore: Erstellen Sie eine .gitignore-Datei, um Ordner und Dateien wie node_modules und .env von der Versionierung auszuschließen.
• .npmignore: Erstellen Sie eine .npmignore-Datei, um anzugeben, welche Dateien und Ordner nicht im NPM-Paket enthalten sein sollen.
• README.md: Erstellen Sie eine Datei mit Informationen zum Paket.

Veröffentlichen des Pakets

Melden Sie sich mit Ihren Anmeldedaten bei NPM an:

npm init

Führen Sie den folgenden Befehl aus, um das Paket zu veröffentlichen:

{
  "name": "string-reverser-jm",
  "version": "1.0.0",
  "description": "A simple utility to reverse strings, useful for demonstrations and small projects.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"No test specified\" && exit 1"
  },
  "author": "Juliana Macedo <contact@starcoders.info> (https://www.starcoders.info)",
  "keywords": [
    "string",
    "reverse",
    "utility"
  ],
  "license": "MIT"
}

Okay, das Paket wird bald in der NPM-Registrierung verfügbar sein!
https://www.npmjs.com/package/string-reverser-jm

Aktualisierung des Pakets

Erhöhen Sie bei Aktualisierungen oder Fehlerbehebungen die Versionsnummer in package.json entsprechend der semantischen Versionierung mit einem der folgenden Befehle:

function reverseString(str) {
  if (typeof str !== "string") {
    throw new TypeError("Expected a string as input");
  }
  return str.split("").reverse().join("");
}

module.exports = reverseString;

Und dann die aktualisierte Version veröffentlichen:

npm link

Häufige Probleme:

• Paketname bereits vergeben: Wenn die Veröffentlichung fehlschlägt, weil bereits ein Paket mit demselben Namen vorhanden ist, wählen Sie einen anderen Namen, der noch nicht vergeben ist.
• Authentifizierungsfehler: Stellen Sie sicher, dass Sie angemeldet sind und über alle erforderlichen Berechtigungen zum Veröffentlichen verfügen.
• Versionskonflikte: Wenn Sie versuchen, zu veröffentlichen, ohne die Versionsnummer zu aktualisieren, lehnt NPM Ihren Beitrag ab. Verwenden Sie die npm-Version, um die Version zu erhöhen.

---

Das obige ist der detaillierte Inhalt vonSo veröffentlichen Sie ein Paket auf npm: eine Schritt-für-Schritt-Anleitung. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!