Comment publier un package sur npm : un guide étape par étape

Publier des packages sur NPM (Node package manager) n'est pas seulement un moyen de partager votre travail avec d'autres développeurs, mais aussi de vous démarquer dans la communauté de développement. Imaginez créer une solution réutilisable qui peut être intégrée dans divers projets à travers le monde, économisant ainsi du temps et des efforts aux autres programmeurs.

Dans cet article, vous apprendrez, étape par étape, comment configurer, publier et maintenir votre propre package sur NPM, rendant vos contributions accessibles et augmentant votre visibilité en tant que développeur.

Conditions préalables

Avant de commencer, assurez-vous d'avoir :

• NPM installé. Vous pouvez le télécharger depuis nodejs.org ou utiliser NVM (Node version manager).
• Un compte créé sur npmjs.com

Exécutez les commandes ci-dessous dans le terminal pour vérifier que l'installation de Node.js et de NPM a réussi.

node -v
npm -v

Si l'installation est correcte, le terminal affichera la version de chacun.
Le résultat sera similaire à celui ci-dessous :

$ v20.18.0 # node -v
$ 10.8.2 # npm -v

Configuration du projet

Commencez par créer un dossier avec le nom que vous souhaitez pour le package. Dans mon cas j'ai choisi "string-reverser-jm".

mkdir string-reverser-jm # cria a pasta via terminal
cd string-reverser-jm # acessa a pasta via terminal

Initialiser NPM :

npm init

Lors de l'exécution de la commande ci-dessus, le terminal vous posera quelques questions pour créer le fichier package.json.
Vous trouverez ci-dessous une explication de chaque élément que nous devons remplir.

• nom : Un identifiant unique pour le colis.
• version : utilisez le versionnage sémantique pour indiquer les modifications.
• description : Une brève explication de ce que fait le package.
• main : Le fichier de point d'entrée, par exemple, index.js.
• mots-clés : mots-clés pour catégoriser et permettre aux autres développeurs de trouver plus facilement le package.
• auteur : ajoutez les détails pertinents de l'auteur.
• licence : La licence définit comment le code peut être utilisé, modifié et distribué par d'autres. La licence la plus courante est la MIT, qui est permissive et permet une grande liberté d'utilisation, à condition que la mention originale du droit d'auteur soit fournie.

Si vous répondez aux questions et que NPM a créé le fichier sans aucune de ces informations, ouvrez le fichier créé dans un éditeur et ajoutez ce qui manque.

Exemple :

{
  "name": "string-reverser-jm",
  "version": "1.0.0",
  "description": "A simple utility to reverse strings, useful for demonstrations and small projects.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"No test specified\" && exit 1"
  },
  "author": "Juliana Macedo <contact@starcoders.info> (https://www.starcoders.info)",
  "keywords": [
    "string",
    "reverse",
    "utility"
  ],
  "license": "MIT"
}

Écrire le code

Créez le fichier index.js à la racine du projet.

function reverseString(str) {
  if (typeof str !== "string") {
    throw new TypeError("Expected a string as input");
  }
  return str.split("").reverse().join("");
}

module.exports = reverseString;

Tester le package

Pour tester le package avant de le publier, nous utiliserons la commande npm link

Dans le répertoire du package, exécutez la commande :

npm link

Dans le projet où vous souhaitez tester le package, exécutez la commande :

node -v
npm -v

Importez et utilisez le package dans votre projet de test pour vous assurer qu'il fonctionne :

$ v20.18.0 # node -v
$ 10.8.2 # npm -v

Pour supprimer les liens créés, exécutez simplement la commande npm unlink string-reverser-jm dans le répertoire du projet de test puis npm unlink dans le répertoire du package.

Préparation du dossier pour publication

Tout d'abord, créez un référentiel Git pour le package et liez-le à NPM. Cela augmente la transparence et la confiance en rendant le code source disponible, facilite les collaborations et les contributions de la communauté, et permet l'automatisation avec CI/CD pour une gestion et une maintenance plus efficaces.

Pour créer un lien vers NPM, copiez l'adresse https du référentiel et ajoutez-la à package.json :

mkdir string-reverser-jm # cria a pasta via terminal
cd string-reverser-jm # acessa a pasta via terminal

• .gitignore : créez un fichier .gitignore pour exclure les dossiers et fichiers, tels que node_modules et .env, de la gestion des versions.
• .npmignore : créez un fichier .npmignore pour spécifier quels fichiers et dossiers ne doivent pas être inclus dans le package NPM.
• README.md : Créez un fichier avec des informations sur le package.

Publication du package

Connectez-vous à NPM en utilisant vos informations de connexion :

npm init

Exécutez la commande ci-dessous pour publier le package :

{
  "name": "string-reverser-jm",
  "version": "1.0.0",
  "description": "A simple utility to reverse strings, useful for demonstrations and small projects.",
  "main": "index.js",
  "scripts": {
    "test": "echo \"No test specified\" && exit 1"
  },
  "author": "Juliana Macedo <contact@starcoders.info> (https://www.starcoders.info)",
  "keywords": [
    "string",
    "reverse",
    "utility"
  ],
  "license": "MIT"
}

D'accord, le package sera bientôt disponible dans le registre NPM !
https://www.npmjs.com/package/string-reverser-jm

Mise à jour du paquet

Lorsque vous effectuez des mises à jour ou des corrections de bugs, augmentez le numéro de version dans package.json en fonction du versionnement sémantique à l'aide de l'une des commandes ci-dessous :

function reverseString(str) {
  if (typeof str !== "string") {
    throw new TypeError("Expected a string as input");
  }
  return str.split("").reverse().join("");
}

module.exports = reverseString;

Et puis publiez la version mise à jour :

npm link

Problèmes fréquents :

• Nom du package déjà pris : Si la publication échoue car un package portant le même nom existe déjà, choisissez un autre nom, celui qui n'a pas encore été pris.
• Erreurs d'authentification : assurez-vous que vous êtes connecté et que vous disposez de toutes les autorisations nécessaires pour publier.
• Conflits de versions : Si vous essayez de publier sans mettre à jour le numéro de version, NPM rejettera votre message. Utilisez la version npm pour augmenter la version.

---

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!