pnpm add <pkg>
Installe un paquet ainsi que ses dépendances. Par défaut, les paquets sont installés comme dépendance de production (aka: "dependencies").
TL;DR
Commande | Signification |
---|---|
pnpm add sax | Sauvegarde en tant que dépendance de production (dependencies ) |
pnpm add -D sax | Sauvegarde en tant que dépendance de développement (devDependencies ) |
pnpm add -O sax | Sauvegarde en tant que dépendance optionnelle (optionalDependencies ) |
pnpm add -g sax | Installe un package globalement |
pnpm add sax@next | Installe la version next de sax |
pnpm add sax@3.0.0 | Installe la version 3.0.0 |
Dépôts de paquets supportés
Installe depuis le dépôt NPM
Par défaut, la commande pnpm add package-name
va installer la dernière version de package-name
depuis le dépôt NPM.
Si elle est exécutée dans un espace de travail, la commande essaiera d'abord de vérifier si d'autres projets dans l'espace de travail utilisent le package spécifié. Si c'est le cas, la version déjà installée sera utilisée.
Vous pouvez également installer des paquets en spécifiant :
- le tag :
pnpm add express@nightly
- la version :
pnpm add express@1.0.0
- un intervalle de versions :
pnpm add express@2 react@">=0.1.0 <0.2.0"
Installer depuis un workspace
À noter que lorsqu'on travaille avec un workspace, et que l'on installe des dépendances, les paquets seront installés depuis les sources configurées. Et cela en fonction de si link-workspace-packages
est configuré et des intervalles de version
.
Installer à partir du système de fichiers local
Il existe deux façons d'installer à partir du système de fichiers local :
- à partir d'une archive (
.tar
,.tar.gz
ou.tgz
) - à partir d'un dossier
Exemples:
pnpm add ./package.tar.gz
pnpm add ./some-directory
Lorsque vous installez à partir d'un dossier, un lien symbolique sera créé dans le dossier node_modules
du projet, donc cela revient à exécuter pnpm link
.
Installer à partir d'une archive distante
L'argument doit être une URL correcte commençant par "http://" ou "https: //".
Exemple:
pnpm add https://github.com/indexzero/forever/tarball/v0.5.6
Installer à partir d'un dépôt Git
pnpm add <git remote url>
Installe le paquet depuis le dépôt Git en le clonant. Vous pouvez utiliser un protocole différent pour certains dépôts Git. Par exemple, pnpm add github:user/repo
Vous pouvez installer depuis Git à partir :
- du dernier commit de master :
pnpm add kevva/is-positive
- d'un commit spécifié :
pnpm add kevva/is-positive#97edff6f525f192a3f83cea1944765f769ae2678
- d'une branche :
pnpm add kevva/is-positive#master
- d'une plage de versions :
pnpm add kevva/is-positive#semver:^2.0.0
You may also install just a subdirectory from a Git-hosted monorepo. Par exemple :
pnpm add myorg/repo#path:packages/foo
It is possible to combine multiple parameters by separating them with &
. For instance, you can extend the above command by specifying which branch to fetch from:
pnpm add myorg/repo#path:packages/foo&next
Options
--save-prod, -P
Installe les paquets spécifiés en tant que dépendance de production (dependencies
).
--save-dev, -D
Installe les paquets spécifiés en tant que dépendance de développement (devDependencies
).
--save-optional, -O
Installe les paquets spécifiés en tant que dépendance optionnelle (optionalDependencies
).
--save-exact, -E
Les dépendances seront installées en utilisant la version exacte au lieu de la version venant de l'opérateur semver.
--save-peer
--save-peer
ajoutera un ou plusieurs paquets en dépendances partagées (peerDependencies
) et les installera en tant que dépendances de développement (devDependencies
).
--ignore-workspace-root-check
On ne peut pas ajouter une dépendance à la racine du workspace à moins de rajouter le paramètre suivant : --ignore-workspace-root-check
ou son raccourci -W
.
Par exemple, pnpm add debug -W
.
--global, -g
Installe un paquet de manière globale.
--workspace
Ajoute uniquement la nouvelle dépendance si elle se trouve dans le workspace.