Node Package Manager, popularnie znany jako npm, to internetowe repozytorium do publikowania pakietów i bibliotek NodeJS.
Jest to również narzędzie wiersza poleceń, które umożliwia interakcję z zarejestrowanymi pakietami. Może pomóc w instalacji pakietów, zarządzaniu wersjami i zarządzaniu zależnościami.
Deweloperzy codziennie publikują swoje biblioteki JavaScript w npm. Proces jest dość prosty, więc i Ty możesz opublikować pakiet w npm.
Krok 1: Instalacja NodeJS
Aby móc współpracować z npm, musisz mieć go globalnie zainstalowany w swoim systemie.
Zacząć od instalowanie NodeJS i npm na Ubuntu, w systemie Windows, lub postępując zgodnie z instrukcjami na NodeJS stronie internetowej.
Krok 2: Tworzenie konta npm
Aby opublikować swoje pakiety w npm, musisz utworzyć konto npm na oficjalnej stronie npm.
Wykonaj poniższe czynności, aby utworzyć konto npm:
- Przejdź do rejestracja npm strona.
- Wpisz swoje dane, zaakceptuj licencję i politykę prywatności, a następnie kliknij „Utwórz konto”.
- Zweryfikuj swój adres e-mail za pomocą linku, który otrzymasz od npm w swojej skrzynce pocztowej.
Jeśli nie zweryfikujesz swojego adresu e-mail, npm zwróci błąd podczas próby opublikowania swoich pakietów.
Krok 3: Inicjowanie repozytorium Git
Następnie musisz zainicjować repozytorium Git, aby śledzić wszystkie zmiany, które wprowadzisz w swoim projekcie.
Na swoim terminalu przejdź do katalogu głównego projektu i uruchom następujące polecenie, aby zainicjować puste repozytorium Git.
git init
Stwórz .gitignore plik i dodaj wszystkie pliki, których nie chcesz śledzić w Git. Następnie uruchom następujące polecenie, aby śledzić pozostałe pliki:
git dodaj -A
Następnie uruchom następujące polecenie, aby wykonać pierwszą migawkę, zatwierdzając kod w usłudze Git.
git popełniać -m Inicjał-popełniać
Możesz wybrać hostuj swoje repozytorium Git na GitHub lub podobna usługa jak Gitlab dla bezproblemowej współpracy.
Krok 4: Inicjowanie npm w projekcie
Następnie zainicjuj npm w projekcie, aby dodać szczegóły dotyczące projektu do pliku package.json. Te dane będą publicznie dostępne w npm.
W terminalu przejdź do katalogu głównego projektu i uruchom następujące polecenie, aby zainicjować npm w swoim projekcie.
początek npm
Powyższe polecenie wywoła zestaw monitów w wierszu poleceń:
- nazwa pakietu: To jest nazwa twojego pakietu npm; musi być unikalny, jeśli chcesz opublikować pakiet w npm; w przeciwnym razie npm zgłosi błąd.
- wersja: Ta właściwość oznacza aktualną wersję twojego pakietu. Musisz go zwiększać za każdym razem, gdy aktualizujesz pakiet, w przeciwnym razie npm zwróci błąd. Wartość domyślna to 1.0.0.
- opis: Ta właściwość jest opisem twojego pakietu. Będzie on publiczny, gdy opublikujesz swój pakiet.
- Punkt wejścia: ta właściwość określa nazwę pliku, w którym rozpoczyna się wykonywanie kodu.
- polecenie testowe: Ta właściwość wskazuje polecenie, które zostanie uruchomione podczas wykonywania test uruchomienia npm.
- repozytorium git: ta właściwość jest adresem URL zdalnego repozytorium Git.
- słowa kluczowe: Ta właściwość oznacza odpowiednie słowa kluczowe dla Twojego projektu, które pomogą wyszukiwarce go znaleźć.
- autor: Ta właściwość powinna być Twoim imieniem lub aliasem.
- licencja: To jest licencja, na której chcesz opublikować pakiet. Domyślną licencją jest licencja Internet Systems Consortium (ISC).
Po skonfigurowaniu możesz stworzyć swój pakiet.
Krok 5: Testowanie paczki
Po zakończeniu tworzenia pakietu należy przetestować go lokalnie, aby zobaczyć, jak będzie się zachowywał po wdrożeniu w npm.
Aby przetestować pakiet lokalnie, najpierw uruchom następujące polecenie w katalogu swojego projektu:
łącze npm
Powyższe polecenie umożliwia odwołanie się do pakietu lokalnie, tak jak do pakietu hostowanego npm.
Następnie utwórz kolejny folder w katalogu głównym projektu i umieść w nim CD.
mkdir test
płyta CDtest
W folderze test uruchom następujące polecenie, aby połączyć pakiet z folderem:
npm link nazwa-twojego-pakiet
Na koniec utwórz fikcyjny plik, aby przetestować funkcjonalność swojego pakietu.
Po zakończeniu testów możesz bezpiecznie usunąć folder testowy.
Krok 6: Logowanie do npm w Twoim systemie
Następnie musisz zalogować się na swoje konto npm w swoim systemie.
Uruchom następujące polecenie, aby zalogować się na swoje konto npm:
logowanie npm
To poprosi Cię o podanie nazwy użytkownika, hasła i dwuskładnikowego kodu uwierzytelniającego (jeśli włączyłeś go na swoim koncie).
Krok 7: Publikowanie paczki
Po wykonaniu wszystkich powyższych kroków uruchom następujące polecenie, aby opublikować pakiet w npm.
publikowanie npm
To polecenie wymaga jednorazowego hasła, które zostanie wysłane na Twój adres e-mail. Następnie opublikuje Twój pakiet w npm.
Możesz przeglądać pakiety, które opublikowałeś na npm. Zaloguj się do swojego konta npm na npmjs.com i przejdź do sekcji paczek na pulpicie swojego profilu.
Aby zainstalować pakiet i używać go jako zależności od dowolnego projektu, uruchom:
npm zainstalowaćNazwa-z-twój-pakiet
Usuwanie paczki z npm
Nadal masz pełną kontrolę nad swoimi pakietami w npm, co oznacza, że możesz modyfikować, a nawet trwale usuwać swój pakiet z npm. Możesz usunąć swoje pakiety, przechodząc do sekcji ustawień swojego pakietu i wybierając opcję usuwania pakietu.