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

• Par défaut : répertoire de travail courant
• Type : chaîne de caractère contenant le chemin d'accès

Modifie l'emplacement du répertoire vers <dir>.

pnpm link <dir>

Permet de lier un paquet depuis le dossier <dir> vers le dossier node_modules relatif au répertoire de travail courant ou bien spécifié le chemin d'accès via l'option--dir.

Par exemple, si vous êtes dans ~/projects/foo et que vous exécutez pnpm link --dir ../bar, alors foo sera lié à bar/node_modules/foo.

pnpm link --global

Permet de lier un paquet depuis le répertoire où cette commande a été exécutée ou bien spécifié via l'option --dir vers le dossier node_modules global, de cette façon il sera accessible depuis un autre paquet avec pnpm link --global <pkg>. De plus si le paquet a un champ bin, le binaire du paquet sera disponible sur tout le système.

pnpm link --global <pkg>

Lie le package spécifié (<pkg>) de global node_modules aux node_modules du package à partir duquel cette commande a été exécutée ou spécifiée via l'option --dir.

Différence entre pnpm link <dir> et pnpm link --dir <dir>

pnpm link <dir> relie le paquet de <dir> au dossier node_modules du paquet où la commande a été exécutée. pnpm link --dir <dir> relie le paquet du répertoire de travail actuel au dossier <dir>.

# Le répertoire actuel est foo
pnpm link ../bar

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

# Le répertoire actuel est 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

Imaginons que vous avez un projet qui utilise le paquet foo. Vous souhaitez apporter des modifications à foo et les tester dans votre projet. Dans ce cas, vous pouvez exécuter pnpm link pour relier la version locale de foo à votre projet, et le package.json ne sera pas modifié.

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

Vous pouvez également relier un paquet d'un répertoire à un autre, sans utiliser le dossier global node_modules :

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

Si vous développez un paquet qui a un binaire, par exemple, un outil CLI, vous pouvez exécuter pnpm link --global pour rendre le binaire disponible sur l'ensemble du système. 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 # installe les dépendances de foo
pnpm link --global # lie foo globablement

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. Cela peut être utile lorsque vous devez utiliser un gestionnaire de paquets spécifique pour le paquet lié, par exemple si vous souhaitez utiliser npm sur le paquet lié et pnpm sur votre projet.

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