Le Node Package Manager, communément appelé npm, est un référentiel en ligne pour la publication de packages et de bibliothèques NodeJS.
C'est également un outil de ligne de commande qui vous permet d'interagir avec les packages enregistrés. Il peut aider à l'installation des packages, à la gestion des versions et à la gestion des dépendances.
Les développeurs publient chaque jour leurs bibliothèques JavaScript sur npm. Le processus est assez simple, vous pouvez donc vous aussi publier un package sur npm.
Étape 1: Installer NodeJS
Pour interagir avec npm, vous devez l'avoir globalement installé sur votre système.
Commence par installer NodeJS et npm sur Ubuntu, sur Windows, ou en suivant les instructions sur le NodeJSName site Internet.
Étape 2: Créer un compte npm
Pour publier vos packages sur npm, vous devez créer un compte npm sur le site officiel npm.
Suivez les étapes ci-dessous pour créer un compte npm :
- Allez à la inscription npm page.
- Remplissez vos coordonnées, acceptez la licence et la politique de confidentialité, puis cliquez sur "créer un compte".
- Vérifiez votre e-mail avec le lien que vous recevrez de npm dans votre boîte aux lettres.
Si vous ne vérifiez pas votre adresse e-mail, npm génère une erreur lorsque vous essayez de publier vos packages.
Étape 3: Initialiser un référentiel Git
Ensuite, vous devez initialiser un référentiel Git pour suivre toutes les modifications que vous apporterez à votre projet.
Sur votre terminal, accédez au répertoire racine de votre projet et exécutez la commande suivante pour initialiser un référentiel Git vide.
git init
Créer un .gitignore dossier et ajoutez tous les fichiers que vous ne voulez pas que Git suive. Exécutez ensuite la commande suivante pour suivre les fichiers restants :
git ajouter -A
Ensuite, exécutez la commande suivante pour prendre votre premier instantané en validant le code dans Git.
git commettre -m initial-commettre
Vous pouvez choisir de hébergez votre référentiel Git sur GitHub ou un service similaire comme Gitlab pour une collaboration fluide.
Étape 4: Initialisation de npm dans votre projet
Ensuite, initialisez npm dans votre projet pour ajouter des détails sur votre projet dans un fichier package.json. Ces détails seront publics sur npm.
Sur votre terminal, accédez au répertoire racine de votre projet et exécutez la commande suivante pour initialiser npm dans votre projet.
initialisation npm
La commande ci-dessus déclenchera un ensemble d'invites sur votre ligne de commande :
- nom du paquet: C'est le nom de votre paquet npm; il doit être unique si vous souhaitez publier le package sur npm; sinon, npm générera une erreur.
- version: Cette propriété indique la version actuelle de votre package. Vous devez l'incrémenter chaque fois que vous mettez à jour votre package ou npm générera une erreur. La valeur par défaut est 1.0.0.
- la description: Cette propriété est la description de votre forfait. Il sera public lorsque vous publierez votre package.
- point d'accès: Cette propriété indique le nom du fichier où l'exécution de votre code commence.
- commande d'essai: Cette propriété indique la commande qui s'exécutera lorsque vous exécuterez test d'exécution npm.
- référentiel git: Cette propriété est l'URL de votre référentiel Git distant.
- mots clés: Cette propriété désigne les mots-clés pertinents à votre projet qui aideront le moteur de recherche à le trouver.
- auteur: Cette propriété doit être votre nom ou votre alias.
- Licence: Il s'agit de la licence sous laquelle vous souhaitez publier le package. La licence par défaut est la licence Internet Systems Consortium (ISC).
Après avoir configuré cela, vous pouvez créer votre package.
Étape 5: test de votre package
Une fois que vous avez fini de créer votre package, vous devez le tester localement pour voir comment il se comporterait après l'avoir déployé sur npm.
Pour tester votre package localement, exécutez d'abord la commande suivante dans le répertoire de votre projet :
lien npm
La commande ci-dessus vous permet de référencer votre package localement comme vous le feriez pour un package hébergé par npm.
Ensuite, créez un autre dossier dans le répertoire racine de votre projet et cd dedans.
mkdir test
CDtest
Dans le dossier de test, exécutez la commande suivante pour lier votre package au dossier :
lien npm nom-de-votre-forfait
Enfin, créez un fichier factice pour tester les fonctionnalités de votre package.
Après avoir terminé vos tests, vous pouvez supprimer en toute sécurité votre dossier de test.
Étape 6: Connexion à npm sur votre système
Ensuite, vous devez vous connecter à votre compte npm sur votre système.
Exécutez la commande suivante pour vous connecter à votre compte npm :
connexion npm
Cela vous demandera de saisir votre nom d'utilisateur, votre mot de passe et un code d'authentification à deux facteurs (si vous l'avez activé sur votre compte).
Étape 7: Publication de votre package
Une fois que vous avez terminé toutes les étapes ci-dessus, exécutez la commande suivante pour publier votre package sur npm.
npm publier
Cette commande nécessite un mot de passe à usage unique qui sera envoyé à votre adresse e-mail. Ensuite, il publiera votre package sur npm.
Vous pouvez afficher les packages que vous avez publiés sur npm. Connectez-vous à votre compte npm sur npmjs.com et accédez à la section des packages sur le tableau de bord de votre profil.
Pour installer votre package et l'utiliser en tant que dépendance sur l'un de vos projets, exécutez :
npm installerNom-de-ton-forfait
Suppression de votre paquet de npm
Vous avez toujours un contrôle total sur vos packages sur npm, ce qui signifie que vous pouvez modifier et même supprimer définitivement votre package depuis npm. Vous pouvez supprimer vos packages en accédant à la section des paramètres de votre package et en sélectionnant l'option de suppression de package.