Créer un module NPM

Si vous utilisez NodeJs, il doit souvent vous arriver d’installer des modules via NPM comme node-fetch, chalk ou encore discord.js !

Mais ne vous êtes-vous jamais demandé comment faire pour publier ses propres modules ? Comment les rendre disponibles sur npmjs.com, et les installer dans différents projets ? C’est ce que vous allez apprendre dans cet article !

// Node fetch permet par exemple de faire simplement des appels HTTP
const fetch = require("node-fetch");
fetch("https://google.fr").then((res) => {
    console.log(res.text());
});

Créons le module

Comme il n’existe pas d’interface web sur npmjs.com pour publier un module, nous allons utiliser le terminal ! Créons donc un nouveau dossier « mon-module » et initialisons-le :

cd mon-module
npm init

Rentrez les informations de votre module, et vous verrez qu’un fichier package.json s’est créé.

{
  "name": "mon-module",
  "version": "0.0.1",
  "description": "Module de test pour le tuto",
  "main": "mon-module.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "test",
    "module"
  ],
  "author": "Androz2091",
  "license": "ISC"
}

Créons le fichier principal, mon-module.js qui contiendra le code de notre module.

module.exports.direBonjour = (personne) => {
    console.log(`Bonjour, ${personne}`);
};

Par exemple, ce module contient une fonction nommée direBonjour.

Publions le module

Publier un module nécessite un compte NPM. Si vous n’en avez pas, vous pouvez vous inscrire ici. Puis, entrez la commande suivante et renseignez vos informations :

npm login

Une fois connecté, il vous suffit de publier le module grâce à cette commande :

npm publish

Rendez-vous sur votre profil NPM et vous verrez que votre module est apparu !

Installer le module

Une seule commande suffit pour télécharger et installer le module :

npm install mon-module

Chargez-le ensuite dans votre code avec le mot-clé require :

const mon_module = require("mon-module");
console.log(mon_module.direBonjour("Androz"));
// Bonjour, Androz !

Félicitations, vous savez maintenant comment fonctionne la publication de modules sur NPM !

Découvrez mes propres modules : discord-giveaways, discord-backup et blague.xyz !

2 ont répondu sur “ Créer un module NPM ”
Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *