logo

Vytvořte a publikujte svůj vlastní balíček NPM

Přehled

Pravděpodobně vás zajímá, jak vytvořit svůj balíček npm a umožnit lidem jej snadno používat pomocí jediného příkazu (npm install/yarn add). V tomto článku vám ukážu, jak publikovat váš balíček npm, a před zveřejněním jej lokálně otestovat 🚀

Krok 1:Vytvořte účet NPM

Přejděte na https://www.npmjs.com/ a vytvořte si účet. Poté, co ověříte svůj účet npmjs. Otevřete terminál a zadejte:

npm login

Zadejte své přihlašovací údaje (uživatelské jméno, heslo a e-mail).

Krok 2:Nastavení nového balíčku NPM

Vytvořte soubor package.json zadáním 

npm init

S následujícím nastavením:

  • Název balíčku:Název vašeho balíčku (zkontrolujte webovou stránku NPM, abyste zjistili, zda je název k dispozici)
  • Verze:1.0.0
  • Popis:Zobrazí se na stránce NPM, takže bude pro uživatele užitečný
  • Vstupní bod:index.js
  • Testovací příkaz:V tuto chvíli můžete toto pole ponechat prázdné
  • Úložiště GitHub:Pokud máte pro svůj modul úložiště GitHub, přidejte jej sem. Zobrazí se na stránce NPM
  • Klíčová slova:To vývojářům usnadní nalezení vašeho balíčku
  • Autor:Vaše jméno
  • Licence:ISC (Toto je standardní licence pro software s otevřeným zdrojovým kódem)

Krok 3:Vytvořte index.js

V tomto příkladu použiji svůj balíček:discord-alert jako příklad (vytvořím balíček discord alert npm s javascriptem, který mi pošle upozornění/zprávu pro discord, když je spuštěna určitá událost).

Vytvořte soubor index.js, který slouží jako hlavní soubor nebo hlavní brána pro náš balíček v kořenovém adresáři vašeho projektu.

Pro náš kód budeme definovat výchozí exportní funkci, která při každém zavolání vytvoří požadavek HTTP. 

// 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);
    });
}

Krok 4:Otestujte balíček lokálně

Než svou práci zveřejníme, musíme se ujistit, že „skutečně funguje“. Proto jej musíme nejprve otestovat lokálně pomocí:

npm link your-package-name

Tento příkaz propojí vaši aktuální aplikaci/projekt s balíčkem, který máte lokálně (řekněme, že máte projekt napsaný v reakci, říkejme mu book-app-store, pro otestování balíčku discord-alert můžete zadat npm odkaz discord-alert a použijte jej lokálně, abyste se ujistili, že funguje)

Krok 5:Publikování

Běh 

npm publish

a od npmjs obdržíte e-mailové upozornění, že váš balíček je již odeslán 🥳

Poznámka: npmjs a yarnpkg jsou nějak propojeny, takže pokud to publikujete na npm , odešlo se to také do yarn , přečtěte si toto pro další informace.

Doufám, že to pomůže! ^^ Příjemné kódování.