pnpm link

Aliases: ln

Rend le paquet local courant accessible depuis le système, ou depuis un autre emplacement.

pnpm link <dir|pkg name>
pnpm link

Options

pnpm link <dir>

Links package from <dir> directory to node_modules of package from where you're executing this command.

For example, if you are inside ~/projects/foo and you execute pnpm link ../bar, then a link to bar will be created in foo/node_modules/bar.

pnpm link

Links package from location where this command was executed to global node_modules, so it can be referred from another package with pnpm link <pkg>. De plus si le paquet a un champ bin, le binaire du paquet sera disponible sur tout le système.

pnpm link <pkg>

Links the specified package (<pkg>) from global node_modules to the node_modules of package from where this command was executed.

Cas d’utilisation

Remplacer le paquet installé par une version locale de celui-ci

Imaginons que vous avez un projet qui utilise le paquet foo. Vous souhaitez apporter des modifications à foo et les tester dans votre projet. In this scenario, you can use pnpm link to link the local version of foo to your project.

cd ~/projects/foo
pnpm install # install dependencies of foo
pnpm link # link foo globally
cd ~/projects/my-project
pnpm link foo # link foo to my-project

You can also link a package from a directory to another directory, without using the global node_modules directory:

cd ~/projects/foo
pnpm install # installer les dépendances de foo
cd ~/projects/my-project
pnpm link ~/projects/foo # lier foo à my-project

Ajouter un binaire globalement

If you are developing a package that has a binary, for example, a CLI tool, you can use pnpm link to make the binary available system-wide. Cela revient au même que si vous exécutez pnpm install -g foo mais il utilisera la version locale de foo plutôt que de le télécharger depuis le registre.

N'oubliez pas que le binaire ne sera disponible que si le paquet a un champ bin dans son package.json.

cd ~/projects/foo
pnpm install # install dependencies of foo
pnpm link # link foo globally

Quelle est la différence entre pnpm link et l'usage du protocole file: ?

Quand vous exécutez pnpm link, le paquet relié est lié symboliquement à partir du code source. Vous pouvez modifier le code source du paquet lié et les modifications seront appliquées dans votre projet. Avec cette méthode, pnpm n'installera pas les dépendances du paquet lié, vous devrez les installer manuellement dans le code source. This may be useful when you have to use a specific package manager for the linked package, for example, if you want to use npm for the linked package, but pnpm for your project.

Quand vous utilisez le protocole file: dans vos dépendances, le paquet lié en dur au node_modules de votre projet, vous pouvez modifier le code source du paquet lié et les modifications seront appliquées à votre projet. Avec cette méthode, pnpm va aussi installer les dépendances du paquet lié, en remplaçant le node_modules du paquet lié.

info

Lorsqu’il s’agit de dépendances entre pairs, il est recommandé d’utiliser le protocole lime:. Il résout mieux les dépendances entre pairs à partir des dépendances du projet, garantissant que la dépendance liée utilise correctement les versions des dépendances spécifiées dans votre projet principal, conduisant à des comportements plus cohérents et attendus.

Fonctionnalité	pnpm link	Protocole file:
Lien symbolique/Lien en dur	Lien symbolique	Lien en dur
Reflète les modifications du code source	Oui	Oui
Installe les dépendances du paquet lié	Non (une installation manuelle est requise)	Oui (remplace node_modules du paquet lié)
Utilisation d'un gestionnaire de paquet différent pour les dépendances	Possible (p. ex., utiliser npm pour lier un paquet)	Non, il utilisera pnpm