Heim Web-Frontend js-Tutorial So veröffentlichen Sie ein Paket auf npm: eine Schritt-für-Schritt-Anleitung

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

Nov 19, 2024 pm 03:55 PM

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
Nach dem Login kopieren
Nach dem Login kopieren

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
Nach dem Login kopieren
Nach dem Login kopieren

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
Nach dem Login kopieren
Nach dem Login kopieren

NPM initialisieren:

npm init
Nach dem Login kopieren
Nach dem Login kopieren

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"
}

Nach dem Login kopieren
Nach dem Login kopieren

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;

Nach dem Login kopieren
Nach dem Login kopieren

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
Nach dem Login kopieren
Nach dem Login kopieren

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

node -v
npm -v
Nach dem Login kopieren
Nach dem Login kopieren

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

$ v20.18.0 # node -v
$ 10.8.2 # npm -v
Nach dem Login kopieren
Nach dem Login kopieren

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
Nach dem Login kopieren
Nach dem Login kopieren
  • .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
Nach dem Login kopieren
Nach dem Login kopieren

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"
}

Nach dem Login kopieren
Nach dem Login kopieren

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;

Nach dem Login kopieren
Nach dem Login kopieren

Und dann die aktualisierte Version veröffentlichen:

npm link
Nach dem Login kopieren
Nach dem Login kopieren

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.

Como publicar um pacote no npm: um guia passo a passo

Como publicar um pacote no npm: um guia passo a passo

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!

Erklärung dieser Website
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn

Heiße KI -Werkzeuge

Undresser.AI Undress

Undresser.AI Undress

KI-gestützte App zum Erstellen realistischer Aktfotos

AI Clothes Remover

AI Clothes Remover

Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

Undress AI Tool

Undress AI Tool

Ausziehbilder kostenlos

Clothoff.io

Clothoff.io

KI-Kleiderentferner

Video Face Swap

Video Face Swap

Tauschen Sie Gesichter in jedem Video mühelos mit unserem völlig kostenlosen KI-Gesichtstausch-Tool aus!

Heißer Artikel

<🎜>: Bubble Gum Simulator Infinity - So erhalten und verwenden Sie Royal Keys
4 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌
Nordhold: Fusionssystem, erklärt
4 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌
Mandragora: Flüstern des Hexenbaum
3 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌
<🎜> obscur: Expedition 33 - So erhalten Sie perfekte Chroma -Katalysatoren
2 Wochen vor By 尊渡假赌尊渡假赌尊渡假赌

Heiße Werkzeuge

Notepad++7.3.1

Notepad++7.3.1

Einfach zu bedienender und kostenloser Code-Editor

SublimeText3 chinesische Version

SublimeText3 chinesische Version

Chinesische Version, sehr einfach zu bedienen

Senden Sie Studio 13.0.1

Senden Sie Studio 13.0.1

Leistungsstarke integrierte PHP-Entwicklungsumgebung

Dreamweaver CS6

Dreamweaver CS6

Visuelle Webentwicklungstools

SublimeText3 Mac-Version

SublimeText3 Mac-Version

Codebearbeitungssoftware auf Gottesniveau (SublimeText3)

Heiße Themen

Java-Tutorial
1676
14
PHP-Tutorial
1278
29
C#-Tutorial
1257
24
Python vs. JavaScript: Die Lernkurve und Benutzerfreundlichkeit Python vs. JavaScript: Die Lernkurve und Benutzerfreundlichkeit Apr 16, 2025 am 12:12 AM

Python eignet sich besser für Anfänger mit einer reibungslosen Lernkurve und einer kurzen Syntax. JavaScript ist für die Front-End-Entwicklung mit einer steilen Lernkurve und einer flexiblen Syntax geeignet. 1. Python-Syntax ist intuitiv und für die Entwicklung von Datenwissenschaften und Back-End-Entwicklung geeignet. 2. JavaScript ist flexibel und in Front-End- und serverseitiger Programmierung weit verbreitet.

JavaScript und das Web: Kernfunktionalität und Anwendungsfälle JavaScript und das Web: Kernfunktionalität und Anwendungsfälle Apr 18, 2025 am 12:19 AM

Zu den Hauptanwendungen von JavaScript in der Webentwicklung gehören die Interaktion der Clients, die Formüberprüfung und die asynchrone Kommunikation. 1) Dynamisches Inhaltsaktualisierung und Benutzerinteraktion durch DOM -Operationen; 2) Die Kundenüberprüfung erfolgt vor dem Einreichung von Daten, um die Benutzererfahrung zu verbessern. 3) Die Aktualisierung der Kommunikation mit dem Server wird durch AJAX -Technologie erreicht.

JavaScript in Aktion: Beispiele und Projekte in realer Welt JavaScript in Aktion: Beispiele und Projekte in realer Welt Apr 19, 2025 am 12:13 AM

Die Anwendung von JavaScript in der realen Welt umfasst Front-End- und Back-End-Entwicklung. 1) Zeigen Sie Front-End-Anwendungen an, indem Sie eine TODO-Listanwendung erstellen, die DOM-Operationen und Ereignisverarbeitung umfasst. 2) Erstellen Sie RESTFUFFUPI über Node.js und express, um Back-End-Anwendungen zu demonstrieren.

Verständnis der JavaScript -Engine: Implementierungsdetails Verständnis der JavaScript -Engine: Implementierungsdetails Apr 17, 2025 am 12:05 AM

Es ist für Entwickler wichtig, zu verstehen, wie die JavaScript -Engine intern funktioniert, da sie effizientere Code schreibt und Leistungs Engpässe und Optimierungsstrategien verstehen kann. 1) Der Workflow der Engine umfasst drei Phasen: Parsen, Kompilieren und Ausführung; 2) Während des Ausführungsprozesses führt die Engine dynamische Optimierung durch, wie z. B. Inline -Cache und versteckte Klassen. 3) Zu Best Practices gehören die Vermeidung globaler Variablen, die Optimierung von Schleifen, die Verwendung von const und lass und die Vermeidung übermäßiger Verwendung von Schließungen.

Python vs. JavaScript: Entwicklungsumgebungen und Tools Python vs. JavaScript: Entwicklungsumgebungen und Tools Apr 26, 2025 am 12:09 AM

Sowohl Python als auch JavaScripts Entscheidungen in Entwicklungsumgebungen sind wichtig. 1) Die Entwicklungsumgebung von Python umfasst Pycharm, Jupyternotebook und Anaconda, die für Datenwissenschaft und schnelles Prototyping geeignet sind. 2) Die Entwicklungsumgebung von JavaScript umfasst Node.JS, VSCODE und WebPack, die für die Entwicklung von Front-End- und Back-End-Entwicklung geeignet sind. Durch die Auswahl der richtigen Tools nach den Projektbedürfnissen kann die Entwicklung der Entwicklung und die Erfolgsquote der Projekte verbessert werden.

Die Rolle von C/C bei JavaScript -Dolmetschern und Compilern Die Rolle von C/C bei JavaScript -Dolmetschern und Compilern Apr 20, 2025 am 12:01 AM

C und C spielen eine wichtige Rolle in der JavaScript -Engine, die hauptsächlich zur Implementierung von Dolmetschern und JIT -Compilern verwendet wird. 1) C wird verwendet, um JavaScript -Quellcode zu analysieren und einen abstrakten Syntaxbaum zu generieren. 2) C ist für die Generierung und Ausführung von Bytecode verantwortlich. 3) C implementiert den JIT-Compiler, optimiert und kompiliert Hot-Spot-Code zur Laufzeit und verbessert die Ausführungseffizienz von JavaScript erheblich.

Python gegen JavaScript: Anwendungsfälle und Anwendungen verglichen Python gegen JavaScript: Anwendungsfälle und Anwendungen verglichen Apr 21, 2025 am 12:01 AM

Python eignet sich besser für Datenwissenschaft und Automatisierung, während JavaScript besser für die Entwicklung von Front-End- und Vollstapel geeignet ist. 1. Python funktioniert in Datenwissenschaft und maschinellem Lernen gut und unter Verwendung von Bibliotheken wie Numpy und Pandas für die Datenverarbeitung und -modellierung. 2. Python ist prägnant und effizient in der Automatisierung und Skripten. 3. JavaScript ist in der Front-End-Entwicklung unverzichtbar und wird verwendet, um dynamische Webseiten und einseitige Anwendungen zu erstellen. 4. JavaScript spielt eine Rolle bei der Back-End-Entwicklung durch Node.js und unterstützt die Entwicklung der Vollstapel.

Von Websites zu Apps: Die verschiedenen Anwendungen von JavaScript Von Websites zu Apps: Die verschiedenen Anwendungen von JavaScript Apr 22, 2025 am 12:02 AM

JavaScript wird in Websites, mobilen Anwendungen, Desktop-Anwendungen und serverseitigen Programmierungen häufig verwendet. 1) In der Website -Entwicklung betreibt JavaScript DOM zusammen mit HTML und CSS, um dynamische Effekte zu erzielen und Frameworks wie JQuery und React zu unterstützen. 2) Durch reaktnatives und ionisches JavaScript wird ein plattformübergreifendes mobile Anwendungen entwickelt. 3) Mit dem Elektronenframework können JavaScript Desktop -Anwendungen erstellen. 4) Node.js ermöglicht es JavaScript, auf der Serverseite auszuführen und unterstützt hohe gleichzeitige Anforderungen.

See all articles