yarn add

パッケージとそれが依存しているパッケージをインストールします。

依存関係の追加

一般に、パッケージはその内容を説明する package.json ファイルとコードが入った単なるフォルダです。 別のパッケージを使いたい場合は、まずそのパッケージを依存関係に追加する必要があります。 つまり、 yarn add [package-name] を実行してプロジェクトにパッケージをインストールするのです。

また、これはあなたのpackage.jsonyarn.lockを更新するため、そのプロジェクトの他の開発者がyarnまたはyarn installを実行した際に、あなたと同じ依存関係を取得することができます。

ほとんどのパッケージはnpmレジストリからインストールされ、単純にパッケージ名で参照されます。 例えば、yarn add reactreactパッケージをnpmレジストリからインストールします。

下記のいずれかの方法でバージョンを指定することができます。

  1. yarn add package-nameはパッケージの”latest”(最新)バージョンをインストールします。
  2. yarn add package-name@1.2.3はレジストリからパッケージの特定のバージョンをインストールします。
  3. yarn add package-name@tagは指定された“tag”をインストールします (例: betanextlatest)。

また、異なる場所からパッケージを指定することもできます。

  1. yarn add package-nameは、package.jsonに別の指定がされていなければ、npmレジストリからパッケージをインストールします。
  2. yarn add file:/path/to/local/folderは、ローカルのファイルシステム上のパッケージをインストールします。これはレジストリに公開されていない、あなた自身のパッケージをテストするのに便利です。
  3. yarn add file:/path/to/local/tarball.tgzは、パッケージの公開前に共有することができるgzip圧縮されたtarアーカイブから、パッケージをインストールします。
  4. yarn add <git remote url>はリモートのgitリポジトリからパッケージをインストールします。
  5. yarn add <git remote url>#<branch/commit/tag>は、指定されたリモートgitリポジトリのgitブランチ、gitコミット、またはgitタグのからパッケージをインストールします。
  6. yarn add https://my-project.org/package.tgzは、リモートのgzip圧縮されたtarアーカイブからパッケージをインストールします。

注意事項

もし、あなたが npm のようなパッケージマネージャを使用していた場合、グローバルな依存関係を追加する方法を探そうとするかもしれません。

大多数のパッケージで、暗黙的であるという理由からグローバルの依存関係を持つことは悪い習慣とされています。 全ての依存関係をローカルに追加することでそれらが明確になり、プロジェクト内の別の人が同じ依存関係を取得することが可能になります。

bin を持つ CLI ツールを使用しようとしている場合、./node_modules/.bin ディレクトリ内で、これらにアクセスすることができます。 また、global コマンドを使用することも可能です。

yarn global add <package...>

コマンド

yarn add <package...>

dependencies に1つまたは複数のパッケージをインストールします。

yarn add <package...> [--dev/-D]

--dev または -D を指定すると、1つまたは複数のパッケージを devDependencies にインストールします。

yarn add <package...> [--peer/-P]

--peer または -P を指定すると、1つまたは複数のパッケージを peerDependencies にインストールします。

yarn add <package...> [--optional/-O]

--optional または -O を指定すると、1つまたは複数のパッケージを optionalDependencies にインストールします。

yarn add <package...> [--exact/-E]

--exact または -E を指定すると、正確なバージョンを指定してパッケージをインストールすることができます。 デフォルトでは、同じメジャーバージョンの最新のリリースが使用されます。 例えば、yarn add foo@1.2.3 はバージョン 1.9.1 を受け入れますが、 yarn add foo@1.2.3 --exact1.2.3 だけを受け入れます。

yarn add <package...> [--tilde/-T]

--tilde または -T を指定すると、同じマイナーバージョンの最新のリリースをインストールします。 デフォルトでは、同じメジャーバージョンの最新のリリースが使用されます。 例えば、yarn add foo@1.2.3 --tilde1.2.9 を受け入れますが、 1.3.0 は受け入れません。