De Node Package Manager, in de volksmond bekend als npm, is een online repository voor het publiceren van NodeJS-pakketten en bibliotheken.

Het is ook een opdrachtregelprogramma waarmee u kunt communiceren met geregistreerde pakketten. Het kan helpen bij pakketinstallatie, versiebeheer en afhankelijkheidsbeheer.

Ontwikkelaars publiceren hun JavaScript-bibliotheken elke dag op npm. Het proces is vrij eenvoudig, dus ook u kunt een pakket op npm publiceren.

Stap 1: NodeJS installeren

Om met npm te kunnen werken, moet het globaal op uw systeem zijn geïnstalleerd.

Start op NodeJS en npm installeren op Ubuntu, op Windows, of door de instructies op de NodeJS website.

Stap 2: Een npm-account aanmaken

Om uw pakketten op npm te publiceren, moet u een npm-account aanmaken op de officiële npm-website.

Volg de onderstaande stappen om een ​​npm-account aan te maken:

  1. Ga naar de npm aanmelden bladzijde.
  2. Vul uw gegevens in, ga akkoord met de licentie en het privacybeleid en klik op "account maken".
  3. Verifieer je e-mail met de link die je van npm in je mailbox ontvangt.
instagram viewer

Als u uw e-mailadres niet verifieert, zal npm een ​​foutmelding geven wanneer u probeert uw pakketten te publiceren.

Stap 3: Een Git-repository initialiseren

Vervolgens moet je een Git-repository initialiseren om alle wijzigingen die je in je project aanbrengt bij te houden.

Navigeer op uw terminal naar de hoofdmap van uw project en voer de volgende opdracht uit om een ​​lege Git-repository te initialiseren.

git init

Maak een .gitignore het dossier en voeg alle bestanden toe waarvan je niet wilt dat Git deze bijhoudt. Voer vervolgens de volgende opdracht uit om de resterende bestanden bij te houden:

git add -A

Voer vervolgens de volgende opdracht uit om uw eerste snapshot te maken door de code naar Git te committen.

git verbinden -m voorletter-verbinden

U kunt ervoor kiezen om host je Git-repository op GitHub of een vergelijkbare service als Gitlab voor een naadloze samenwerking.

Stap 4: npm initialiseren in uw project

Initialiseer vervolgens npm in uw project om details over uw project toe te voegen aan een package.json-bestand. Deze gegevens worden op npm openbaar gemaakt.

Navigeer op uw terminal naar de hoofdmap van uw project en voer de volgende opdracht uit om npm in uw project te initialiseren.

npm init

De bovenstaande opdracht activeert een reeks prompts op uw opdrachtregel:

  • verpakkingsnaam: Dit is de naam van uw npm-pakket; het moet uniek zijn als je het pakket op npm wilt publiceren; anders zal npm een ​​foutmelding geven.
  • versie: Deze eigenschap geeft de huidige versie van uw pakket aan. U moet het elke keer dat u uw pakket bijwerkt verhogen, anders geeft npm een ​​foutmelding. De standaardwaarde is 1.0.0.
  • Omschrijving: Deze eigenschap is de beschrijving van uw pakket. Het zal openbaar zijn wanneer u uw pakket publiceert.
  • ingangspunt: Deze eigenschap geeft de bestandsnaam aan waar de uitvoering van uw code begint.
  • test commando: Deze eigenschap geeft het commando aan dat wordt uitgevoerd wanneer u het uitvoert npm test uitvoeren.
  • git-repository: Deze eigenschap is de URL voor uw externe Git-repository.
  • trefwoorden: Deze eigenschap geeft de relevante trefwoorden voor uw project aan die de zoekmachine helpen het te vinden.
  • auteur: Deze eigenschap moet uw naam of alias zijn.
  • licentie: Dit is de licentie waaronder u het pakket wilt publiceren. De standaardlicentie is de Internet Systems Consortium (ISC)-licentie.

Nadat je dit hebt ingesteld, kun je je pakket samenstellen.

Stap 5: Uw pakket testen

Nadat u klaar bent met het maken van uw pakket, moet u het lokaal testen om te zien hoe het zich zou gedragen nadat u het op npm hebt geïmplementeerd.

Om uw pakket lokaal te testen, voert u eerst de volgende opdracht uit in de map van uw project:

npm-link

Met de bovenstaande opdracht kunt u lokaal naar uw pakket verwijzen zoals u zou doen met een door npm gehost pakket.

Maak vervolgens een andere map in de hoofdmap van uw project en cd erin.

mkdir testen
CDtesten

Voer in de testmap de volgende opdracht uit om uw pakket aan de map te koppelen:

npm link naam-van-uw-pakket

Maak ten slotte een dummy-bestand om de functionaliteit van uw pakket te testen.

Na het voltooien van uw tests, kunt u uw testmap veilig verwijderen.

Stap 6: Inloggen bij npm op uw systeem

Vervolgens moet u inloggen op uw npm-account op uw systeem.

Voer de volgende opdracht uit om in te loggen op uw npm-account:

npm inloggen

Dit zal u vragen om uw gebruikersnaam, wachtwoord en een tweefactorauthenticatiecode in te vullen (als u deze in uw account hebt ingeschakeld).

Stap 7: Uw pakket publiceren

Nadat u alle bovenstaande stappen hebt voltooid, voert u de volgende opdracht uit om uw pakket op npm te publiceren.

npm publiceren

Voor deze opdracht is een eenmalig wachtwoord vereist voor uw e-mail. Vervolgens publiceert het uw pakket op npm.

Op npm kunt u de door u gepubliceerde pakketten bekijken. Log in op uw npm-account op npmjs.com en navigeer naar het gedeelte Pakketten op uw profieldashboard.

Om uw pakket te installeren en het te gebruiken als een afhankelijkheid van een van uw projecten, voert u het volgende uit:

npm installerennaam-van-uw-pakket

Uw pakket verwijderen van npm

U heeft nog steeds volledige controle over uw pakketten op npm, wat betekent dat u uw pakket permanent van npm kunt wijzigen en zelfs verwijderen. U kunt uw pakketten verwijderen door naar het gedeelte Instellingen van uw pakket te gaan en de optie Pakket verwijderen te selecteren.