Utiliser npm link pour tester un module localement

Quand on développe un package NPM, il y a un problème très vite frustrant :

À chaque modification du module, il faudrait normalement :

• publier une nouvelle version
• réinstaller le package dans le projet de test
• relancer l’application

Heureusement, npm link existe justement pour éviter ça.

Fonctionnement

Cette commande permet de créer un lien symbolique entre un package local et un autre projet.

Autrement dit : votre projet utilise directement le code source local du module, comme s’il avait été installé depuis NPM.

Le fonctionnement se fait en deux étapes. D’abord, dans le dossier du paquet NPM :

npm link

Cette commande enregistre le package globalement sur votre machine.

Ensuite, dans le projet qui doit utiliser ce package :

npm link nom-du-package

À partir de ce moment-là, le dossier node_modules du projet pointera directement vers votre module local.

Un lien symbolique

Le gros avantage, c’est que les modifications deviennent quasiment instantanées. Vous changez du code dans votre package… et votre projet de test utilise immédiatement la nouvelle version.

Plus besoin de publier une version 0.0.1-dev-test-42.

Sous le capot, npm link utilise des liens symboliques (symlink) du système d’exploitation.

Un exemple concret

Voici un exemple pour bien comprendre la marche à suivre. Vous avez deux projets :

mon-package/
mon-app/

npm link

npm link mon-package

Et voilà. Votre application utilise maintenant directement la version locale du package.