Tworzenie i publikowanie pakietów prywatnych

spis treści

aby udostępnić swój kod ograniczonej liczbie użytkowników lub zespołów, możesz opublikować Pakiety prywatne o zasięgu użytkownika lub o zasięgu organizacji w rejestrze npm.

aby uzyskać więcej informacji na temat zakresów i pakietów prywatnych, zobacz “o zakresach” i “o pakietach prywatnych”.

Uwaga: zanim będziesz mógł publikować prywatne Pakiety npm, musisz założyć płatne konto użytkownika npm.

dodatkowo, aby publikować prywatne Pakiety o zasięgu organizacji, należy utworzyć konto użytkownika npm, a następnie utworzyć płatną organizację npm.

Tworzenie prywatnego pakietu

  1. Jeśli używasz npmrc do zarządzania kontami na wielu rejestrach, w wierszu poleceń przejdź do odpowiedniego profilu:

    npmrc<nazwa profilu>

  2. w wierszu poleceń utwórz katalog dla swojego pakietu:

    mkdir my-test-package

  3. przejdź do katalogu głównego pakietu:

    CD my-test-package

  4. Jeśli używasz Gita do zarządzania kodem pakietu, w katalogu głównym pakietu uruchom następujące polecenia, zastępując git-remote-url zdalnym adresem URL Twojego pakietu:

    git init
    Git remote dodaj początek git://git-remote-url

  5. w katalogu głównym pakietu uruchom polecenie npm init i przekaż zakres do znacznika scope:

    • dla pakietu o zasięgu organizacji zastąp my-org nazwą swojej organizacji:

    • w przypadku pakietu o zasięgu użytkownika zastąpmy-username

  6. odpowiedz na monity o wygenerowaniepackage.jsonplik. Aby uzyskać pomoc w nadaniu nazwy pakietowi, zobacz “wytyczne dotyczące nazw pakietów”.

  7. Utwórz plik README, który wyjaśnia, czym jest Twój kod pakietu i jak go używać.

  8. w preferowanym edytorze tekstu wpisz kod pakietu.

  9. przeglądanie zawartości pakietu pod kątem poufnych lub niepotrzebnych informacji

    publikowanie poufnych informacji do rejestru może zaszkodzić użytkownikom, zagrozić infrastrukturze programistycznej, być kosztowne w naprawie i narażać na działanie prawne. Zdecydowanie zalecamy usunięcie poufnych informacji, takich jak klucze prywatne, hasła i dane karty kredytowej przed opublikowaniem pakietu w rejestrze. Nawet jeśli pakiet jest prywatny, poufne informacje mogą zostać ujawnione, jeśli pakiet zostanie upubliczniony lub pobrany na komputer, do którego ma dostęp Więcej użytkowników niż zamierzono.

    w przypadku mniej poufnych informacji, takich jak dane testowe, użyj pliku.npmignore lub.gitignore, aby zapobiec publikowaniu w rejestrze. Aby uzyskać więcej informacji, zobacz ten artykuł.

    testowanie pakietu

    aby zmniejszyć ryzyko publikowania błędów, zalecamy przetestowanie pakietu przed opublikowaniem go w rejestrze npm. Aby przetestować pakiet, uruchom npm install z pełną ścieżką do katalogu pakietu:

    npm install my-package

    Publishing private packages

    domyślnie pakiety z zakresami są publikowane z widocznością prywatną.

    1. w wierszu poleceń przejdź do katalogu głównego pakietu.

      cd /path/to/package

    2. aby opublikować swój prywatny pakiet w rejestrze npm, Uruchom:

      npm publish

    3. aby wyświetlić stronę prywatnego pakietu, odwiedźhttps://npmjs.com/package/*package-name, zastępując nazwę pakietu* nazwą twojej paczki. Pakiety prywatne będą zawierały private pod nazwą pakietu na stronie npm.

    aby uzyskać więcej informacji na temat poleceniapublish, zobacz dokumentację CLI.

Dodaj komentarz

Twój adres e-mail nie zostanie opublikowany.