Comment créer votre premier package et le publier dans NPM

Publier notre propre package sur NPM (Node Package Manager) est un excellent moyen de partager, d'apprendre le code avec la communauté ou de faciliter la réutilisation dans nos propres projets. Dans ce guide, nous apprendrons étape par étape comment créer, configurer et publier notre premier package dans NPM.

1. Qu'est-ce qu'un package NPM ?

Un package NPM est un module JavaScript que vous pouvez installer et utiliser dans les projets Node.js. Cela peut être aussi simple qu'une fonction réutilisable ou aussi complexe qu'une bibliothèque entière.

2. Conditions préalables

Avant de commencer, nous devons nous assurer de répondre aux exigences suivantes :

Node.js et NPM installés : téléchargez et installez à partir de Node.js.
Compte NPM : inscrivez-vous sur npmjs.com.
Éditeur de code : Comme VS Code, pour rédiger et organiser votre projet.

3. Configurez votre projet

Étape 1 : Créez un dossier pour votre colis
Ouvrez votre terminal et créez un dossier :

mkdir mi-primer-paquete
cd mi-primer-paquete

On ouvre le dossier dans notre éditeur de code :

code .

Étape 2 : Initialiser le projet
Nous exécutons la commande suivante pour créer un fichier package.json :

initialisation npm

Répondez aux questions ou utilisez npm init -y pour accepter les valeurs par défaut.

Vérifiez le fichier package.json généré. Cela devrait ressembler à ceci :

{
  "name": "mi-primer-paquete",
  "version": "1.0.0",
  "description": "Mi primer paquete publicado en NPM",
  "main": "index.js",
  "scripts": {},
  "keywords": ["npm", "paquete", "tutorial"],
  "author": "Tu Nombre",
  "license": "MIT"
}

Étape 3 : Créer le fichier principal

Créez un fichier appelé index.js à la racine du projet :

touchez index.js
Ajoutez une fonction simple à titre d'exemple :

function holaMundo() {
    return "¡Hola, mundo!";
}
module.exports = holaMundo;

4. Publier le package

Étape 1 : Connectez-vous à NPM
Exécutez la commande suivante dans votre terminal et suivez les instructions pour vous connecter :

Connexion npm

Étape 2 : Publier le package
Exécutez cette commande pour publier votre package sur NPM :

publication npm
Prêt! Votre package sera désormais disponible publiquement sur NPM.

5. Testez le package

Pour vous assurer que votre package fonctionne, testez-le en l'installant dans un autre projet :

Créez un nouveau dossier pour les tests :

mkdir prueba-paquete
cd prueba-paquete

Initialisez un projet puis installez le package :

npm init -y
npm install mi-primer-paquete

Utiliser le package dans un fichier :

const holaMundo = require("mi-primer-paquete");

console.log(holaMundo()); // ¡Hola, mundo!

6. Mettre à jour un package

Si nous devons apporter des modifications, mettez simplement à jour le code, incrémentez la version dans package.json (par exemple, changez "version": "1.0.0" en "version": "1.0.1") et republiez-le :

publication npm

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!