logo
 JavaScript >> Javascript-Tutorial >  >> Tags >> npm

Erstellen und veröffentlichen Sie Ihr eigenes NPM-Paket

Übersicht

Sie fragen sich wahrscheinlich, wie Sie Ihr npm-Paket erstellen und Benutzern die einfache Verwendung mit nur einem einzigen Befehl ermöglichen (npm install/yarn add). In diesem Artikel zeige ich Ihnen, wie Sie Ihr npm-Paket veröffentlichen und es lokal testen, bevor Sie es veröffentlichen 🚀

Schritt 1:NPM-Konto erstellen

Gehen Sie zu https://www.npmjs.com/, um ein Konto zu erstellen. Nachdem Sie Ihr npmjs-Konto verifiziert haben. Öffnen Sie Ihr Terminal und geben Sie Folgendes ein:

npm login

Geben Sie Ihre Anmeldedaten ein (Benutzername, Passwort und E-Mail).

Schritt 2:Richten Sie ein neues NPM-Paket ein

Erstellen Sie eine package.json, indem Sie sie eingeben 

npm init

Mit folgenden Einstellungen:

  • Paketname:Der Name Ihres Pakets (sehen Sie auf der NPM-Website nach, ob der Name verfügbar ist)
  • Version:1.0.0
  • Beschreibung:Dies wird auf der NPM-Seite erscheinen, damit es für Benutzer hilfreich ist
  • Einstiegspunkt:index.js
  • Testbefehl:Sie können dies im Moment leer lassen
  • GitHub-Repository:Wenn Sie ein GitHub-Repository für Ihr Modul haben, fügen Sie es hier hinzu. Diese erscheint auf der NPM-Seite
  • Schlüsselwörter:Dies erleichtert Entwicklern das Auffinden Ihres Pakets
  • Autor:Ihr Name
  • Lizenz:ISC (Dies ist die Boilerplate-Lizenz für Open-Source-Software)

Schritt 3:Index.js erstellen

In diesem Beispiel verwende ich mein Paket:discord-alert als Beispiel (ich erstelle ein Discord-Alert-npm-Paket mit Javascript, um mir eine Benachrichtigung/Nachricht an Discord zu senden, wenn ein bestimmtes Ereignis ausgelöst wird).

Erstellen Sie eine index.js-Datei, die als Hauptdatei oder Hauptgateway für unser Paket im Stammverzeichnis Ihres Projekts dient.

Für unseren Code werden wir eine Export-Standardfunktion definieren, die bei jedem Aufruf eine HTTP-Anfrage stellt. 

// fetch api already introduced in Node v17 as experimental feature,
// hence we can use it without importing other dependency in the future
import fetch from "node-fetch";

export default function Notification(url, message) {
  fetch(url, {
    body: JSON.stringify({
      content: message,
    }),
    headers: {
      "Content-Type": "application/json",
    },
    method: "POST",
  })
    .then(function (res) {})
    .catch(function (res) {
      console.log(res);
    });
}

Schritt 4:Testen Sie das Paket lokal

Bevor wir unsere Arbeit veröffentlichen, müssen wir sicherstellen, dass sie „wirklich funktioniert“. Daher müssen wir es zuerst lokal testen, indem wir Folgendes verwenden:

npm link your-package-name

Dieser Befehl verknüpft Ihre aktuelle App/Ihr aktuelles Projekt mit dem Paket, das Sie lokal haben (sagen wir, Sie haben ein Projekt, das in React geschrieben ist, nennen wir es Buch-App-Store, um das Discord-Alert-Paket zu testen, können Sie eingeben npm link discord-alert , und verwenden Sie es lokal, um sicherzustellen, dass es funktioniert)

Schritt 5:Veröffentlichen

Laufen 

npm publish

und Sie erhalten eine E-Mail-Benachrichtigung von npmjs, dass Ihr Paket bereits versendet wurde 🥳

Hinweis: npmjs und Garnpkg sind irgendwie verbunden, daher wird es auch an Garn gesendet, wenn Sie es in npm veröffentlichen. Lesen Sie dies für weitere Informationen.

Ich hoffe es hilft! ^^ Viel Spaß beim Programmieren.