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
| Command | Meaning |
|---|---|
pnpm add sax | Save to dependencies |
pnpm add -D sax | Save to devDependencies |
pnpm add -O sax | Save to optionalDependencies |
pnpm add -g sax | Installe un package globalement |
pnpm add sax@next | Install from the next tag |
pnpm add sax@3.0.0 | Specify version 3.0.0 |
Dépôts de paquets supportés
Installe depuis le dépôt NPM
pnpm add package-name will install the latest version of package-name from
the npm registry by default.
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 :
- tag:
pnpm add express@nightly - version:
pnpm add express@1.0.0 - version range:
pnpm add express@2 react@">=0.1.0 <0.2.0"
Installer depuis un workspace
Note that when adding dependencies and working within a workspace, packages
will be installed from the configured sources, depending on whether or not
link-workspace-packages is set, and use of the
workspace: range protocol.
Installer à partir du système de fichiers local
Il existe deux façons d'installer à partir du système de fichiers local :
- from a tarball file (
.tar,.tar.gz, or.tgz) - à partir d'un dossier
Exemples :
pnpm add ./package.tar.gz
pnpm add ./some-directory
When you install from a directory, a symlink will be created in the current
project's node_modules, so it is the same as running 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>
Installs the package from the hosted Git provider, cloning it with Git.
You may install packages from Git by:
- Latest commit from default branch:
pnpm add kevva/is-positive
- Git commit hash:
pnpm add kevva/is-positive#97edff6f525f192a3f83cea1944765f769ae2678
- Git branch:
pnpm add kevva/is-positive#master
- Git branch relative to refs:
pnpm add zkochan/is-negative#heads/canary
- Git tag:
pnpm add zkochan/is-negative#2.0.1
- V-prefixed Git tag:
pnpm add andreineculau/npm-publish-git#v0.0.7
- Version range:
pnpm add kevva/is-positive#semver:^2.0.0
Semver
You can specify version (range) to install using the semver: parameter. Par exemple:
- Strict semver:
pnpm add zkochan/is-negative#semver:1.0.0
- V-prefixed strict semver:
pnpm add andreineculau/npm-publish-git#semver:v0.0.7
- Semver version range:
pnpm add kevva/is-positive#semver:^2.0.0
- V-prefixed semver version range:
pnpm add andreineculau/npm-publish-git#semver:<=v0.0.7
Subdirectory
You may also install just a subdirectory from a Git-hosted monorepo using the path: parameter. Par exemple :
pnpm add RexSkz/test-git-subfolder-fetch#path:/packages/simple-react-app
Full URL
If you want to be more explicit or are using alternative Git hosting, you might want to spell out full Git URL:
# git+ssh
pnpm add git+ssh://git@github.com:zkochan/is-negative.git#2.0.1
# https
pnpm add https://github.com/zkochan/is-negative.git#2.0.1
Providers shorthand
You can use a protocol shorthand [provier]: for certain Git providers:
pnpm add github:zkochan/is-negative
pnpm add bitbucket:pnpmjs/git-resolver
pnpm add gitlab:pnpm/git-resolver
If [provider]: is omited, it defaults to github:.
Parameters combination
It is possible to combine multiple parameters by separating them with &. This can be useful for forks of monorepos:
# Install git branch `beta`
# Install only subfolder `/packages/simple-react-app`
pnpm add RexSkz/test-git-subfolder-fetch.git#beta&path:/packages/simple-react-app
Options
--save-prod, -P
Install the specified packages as regular dependencies.
--save-dev, -D
Install the specified packages as devDependencies.
--save-optional, -O
Install the specified packages as 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
Using --save-peer will add one or more packages to peerDependencies and
install them as dev dependencies.
--ignore-workspace-root-check
Adding a new dependency to the root workspace package fails, unless the
--ignore-workspace-root-check or -w flag is used.
For instance, 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.