pnpm add <pkg>
パッケージとそれが依存しているすべてのパッケージをインストールします。 デフォルトでは、すべての新しいパッケージは production 依存として追加されます。
概要
| コマンド | 意味 |
|---|---|
pnpm add sax | dependencies へ保存 |
pnpm add -D sax | devDependencies へ保存 |
pnpm add -O sax | optionalDependencies へ保存 |
pnpm add -g sax | グローバルにインストール |
pnpm add sax@next | next タグに対応するバージョンを保存 |
pnpm add sax@3.0.0 | バージョン 3.0.0 を指定 |
サポートされているパッケージの取得先
npm レジストリからインストール
pnpm add package-name はデフォルトでは、最新のバージョンの package-name を npm registry より追加します。
ワークスペースで実行された場合、最初に他のプロジェクトが指定された依存パッケージを使用しているかどうかを確認しようとします。 その場合、すでに使用されているバージョン範囲がインストールされます。
また、次のようにパッケージをインストールすることも可能です。
- tag を指定:
pnpm add express@nightly - バージョンを指定:
pnpm add express@1.0.0 - バージョン範囲を指定:
pnpm add express@2 react@">=0.1.0 <0.2.0"
ワークスペースからインストール
ワークスペース から依存を追加して作業する場合は、依存パッケージの取得先は、 link-workspace-packages と workspace: プロトコルの範囲指定 の設定によって決定されます。
ローカルファイルシステムからインストール
ローカルファイルシステムからインストールする方法は2つあります。
- tarball ファイルから (
.tar,.tar.gz, or.tgz) - ディレクトリから
例:
pnpm add ./package.tar.gz
pnpm add ./some-directory
ディレクトリからインストールする場合は、現在のプロジェクトの node_modules にシンボリックリンクが作成されるため、pnpm link を実行した場合と同様になります。
リモートの tarball からインストール
引数は、 "http://" または "https://" で始まるフェッチ可能な URL でなければなりません。
例:
pnpm add https://github.com/indexzero/forever/tarball/v0.5.6
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. 例:
- 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. 例：
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
オプション
--save-prod, -P
指定されたパッケージを通常の dependencies としてインストールします。
--save-dev, -D
指定されたパッケージを通常の devDependencies としてインストールします。
--save-optional, -O
指定されたパッケージを通常の optionalDependencies としてインストールします 。
--save-exact, -E
pnpm のデフォルトの semver 範囲指定演算子を使用するのではなく、固定したバージョンで保存します。
--save-peer
--save-peer を使うことで、1つ以上の依存パッケージを peerDependencies と devDependencies の両方に追加します。
--ignore-workspace-root-check
--ignore-workspace-root-check または -w フラグが使用されていない限り、新しい依存関係をワークスペースのルートに追加しようとすると失敗します。
例: pnpm add debug -w
--global, -g
パッケージをグローバルにインストールします。
--workspace
ワークスペースで見つかった場合にのみ、新しい依存関 係を追加します。