Vytváření a publikování vlastní balíčky

obsah

sdílet svůj kód s omezenou skupinu uživatelů nebo týmů, můžete publikovat soukromé rozsahem na úrovni uživatele nebo organizace-scoped balíčků npm registru.

Další informace o oborech a soukromých balíčcích naleznete v části “o oborech” a “o soukromých balíčcích”.

Poznámka: než budete moci publikovat soukromé balíčky npm s rozsahem uživatelů, musíte se zaregistrovat k placenému uživatelskému účtu npm.

kromě toho, Chcete-li publikovat balíčky s rozsahem soukromých organizací, musíte vytvořit uživatelský účet npm a poté vytvořit placenou organizaci npm.

Vytvořit vlastní balíček

  1. Pokud používáte npmrc spravovat účty na více registrech, na příkazový řádek, přepněte na odpovídající profil:

    npmrc <profil-název>

  2. Na příkazovém řádku vytvořte adresář pro váš balíček:

    mkdir moje-test-balíček

  3. Přejděte do kořenového adresáře balíčku:

    cd moje-test-balíček

  4. Pokud používáte git pro správu vašeho balíčku zákoníku, ve balíček kořenového adresáře, spusťte následující příkazy nahrazení git-remote-url git remote URL pro váš balíček:

    git init
    git remote add origin git://git-remote-url

  5. balíček kořenový adresář, spustit npm init příkaz a předat rozsahu na scope flag:

    • Pro organizace, rozsahem balíček, nahradit my-org s název vaší organizace:

    • Pro uživatele-scoped balíček, nahradit my-username s vaše uživatelské jméno:

      npm init [email protected]živatelské jméno

  6. Reagovat na výzvy, aby generovat package.json soubor. Informace o pojmenování balíčku naleznete v části “Pokyny pro Název balíčku”.

  7. Vytvořte soubor README, který vysvětluje, jaký je váš kód balíčku a jak jej používat.

  8. ve vašem preferovaném textovém editoru napište kód pro váš balíček.

Revize obsah balení pro citlivé nebo zbytečné informace

Publikování citlivých informací do registru se může poškodit vaše uživatele ohrozit váš rozvoj infrastruktury, být drahé opravit, a dát si na riziko právní kroky. Důrazně doporučujeme před zveřejněním balíčku do registru odstranit citlivé informace, jako jsou soukromé klíče, hesla (PII) a údaje o kreditní kartě. I když je váš balíček soukromý, citlivé informace mohou být odhaleny, pokud je balíček zveřejněn nebo stažen do počítače, ke kterému má přístup více uživatelů, než bylo zamýšleno.

pro méně citlivé informace, jako jsou testovací data, použijte soubor .npmignore nebo .gitignore, abyste zabránili publikování v registru. Další informace naleznete v tomto článku.

testování balíčku

Chcete-li snížit pravděpodobnost publikování chyb, doporučujeme balíček otestovat před jeho zveřejněním v registru npm. Otestovat váš balíček, spusťte npm install, s úplnou cestu k balíčku adresář:

npm nainstalovat balíček

Publikování soukromých balení

ve výchozím nastavení, rozsahem balíčky jsou publikovány s vlastní zviditelnění.

  1. na příkazovém řádku přejděte do kořenového adresáře vašeho balíčku.

    cd /cesta/k/balíčku

  2. publikovat svůj vlastní balíček npm registru, běh:

    npm publikovat

  3. ukázat své soukromé balíček webové stránky, navštivte https://npmjs.com/package/*package-name, nahradí jméno-balíku* s názvem vašeho balíčku. Soukromé balíčky budou pod názvem balíčku na webových stránkách npm říkat private.

více informací na publish příkazu, viz CLI dokumentace.

Napsat komentář

Vaše e-mailová adresa nebude zveřejněna.