Comment utiliser ou exécuter un package installé à l'aide de npm

Comment inclure et utiliser dans votre code un package installé dans votre dossier node_modules

Lorsque vous installez en utilisantnpmun paquet dans votrenode_modulesdossier, ou aussi globalement, comment l'utilisez-vous dans votre code Node?

Dites que vous installezlodash, la populaire bibliothèque d'utilitaires JavaScript, utilisant

npm install lodash

Cela va installer le package dans le localnode_modulesdossier.

Pour l'utiliser dans votre code, il vous suffit de l'importer dans votre programme en utilisantrequire:

const _ = require('lodash')

Et si votre package est un exécutable?

Dans ce cas, il placera le fichier exécutable sous lenode_modules/.bin/dossier.

Un moyen simple de le démontrer estvache.

Le paquet cowsay fournit un programme en ligne de commande qui peut être exécuté pour faire dire quelque chose à une vache (et à d'autres animaux aussi 🦊).

Lorsque vous installez le package en utilisantnpm install cowsay, il s'installera lui-même et quelques dépendances dans le dossier node_modules:

The node_modules folder content

Il existe un dossier .bin caché, qui contient des liens symboliques vers les binaires de cowsay:

The binary files

Comment les exécutez-vous?

Vous pouvez bien sûr taper./node_modules/.bin/cowsaypour l'exécuter, et ça marche, maisnpx, inclus dans les versions récentes de npm (depuis la version 5.2), est une bien meilleure option. Vous venez de courir:

npx cowsay

et npx trouvera l'emplacement du package.

Cow says something

Téléchargez mon gratuitManuel de Node.js


Plus de didacticiels sur les nœuds: