pnpm link

Aliases: ln

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

pnpm link <dir>
pnpm link --global
pnpm link --global <pkg>

Options

--dir <dir>, -C

• Default: Current working directory
• Type: Path string

Changes the link location to <dir>.

pnpm link <dir>

Links package from <dir> folder to node_modules of package from where you're executing this command or specified via --dir option.

For example, if you are inside ~/projects/foo and you execute pnpm link --dir ../bar, then foo will be linked to bar/node_modules/foo.

pnpm link --global

Links package from location where this command was executed or specified via --dir option to global node_modules, so it can be referred from another package with pnpm link --global <pkg>. Also if the package has a bin field, then the package's binaries become available system-wide.

pnpm link --global <pkg>

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

Difference between pnpm link <dir> and pnpm link --dir <dir>

pnpm link <dir> links the package from <dir> to the node_modules of the package where the command was executed. pnpm link --dir <dir> links the package from the current working directory to <dir>.

# The current directory is foo
pnpm link ../bar

- foo
  - node_modules
    - bar -> ../../bar
- bar

# The current directory is bar
pnpm link --dir ../foo

- foo
  - node_modules
    - bar -> ../../bar
- bar

Cas d’utilisation

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

Let's say you have a project that uses foo package. You want to make changes to foo and test them in your project. In this scenario, you can use pnpm link to link the local version of foo to your project, while the package.json won't be modified.

cd ~/projects/foo
pnpm install # installe les dépendances de foo
pnpm link --global # lie foo globalement
cd ~/projects/my-project
pnpm link --global foo # lie foo à my-project

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

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 --global to make the binary available system-wide. This is the same as using pnpm install -g foo, but it will use the local version of foo instead of downloading it from the registry.

Remember that the binary will be available only if the package has a bin field in its package.json.

cd ~/projects/foo
pnpm install # installe les dépendances de foo
pnpm link --global # lie foo globablement

What's the difference between pnpm link and using the file: protocol?

When you use pnpm link, the linked package is symlinked from the source code. 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 usefull 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.

When you use the file: protocol in dependencies, the linked package is hard-linked to your project node_modules, you can modify the source code of the linked package, and the changes will be reflected in your project. With this method pnpm will also install the dependencies of the linked package, overriding the node_modules of the linked package.

info

When dealing with peer dependencies it is recommended to use the file: protocol. 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	file: Protocol
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)	Yes (overrides node_modules of the linked package)
Utilisation d'un gestionnaire de paquet différent pour les dépendances	Possible (e.g., use npm for linked pkg)	Non, il utilisera pnpm