Yarnのインストールと使用方法
Software
パッケージマネージャー
目次Yarnとは
Yarnとはnpm互換のJavaScriptのパッケージマネージャーです。
パッケージマネージャーとは
パッケージマネージャーは、ソフトウェアのインストール、更新、削除を容易に行えるようにするツールです。
パッケージマネージャーを導入するとスマートフォンのアプリのようにソフトウェアを一括で更新したり、現在のソフトウェア環境を別PCにコピーすることもできます。
npmとの違い
- npmよりパッケージのインストールが速い
- 厳密にモジュールのバージョンを固定できる
Yarnのインストール
Node.js（npm）をインストール後に以下のコマンドを実行すると導入されます。
npm i -g yarn
上記コマンド実行後yarn -vを実行しバージョンが表示されればインストール完了です。
> yarn -v
1.22.10
Yarnの主な用語
| 用語 | 内容 |
|---|---|
package.json |
プロジェクトの情報が記録されるファイル |
yarn.lock |
インストールしたパッケージの完全なバージョンが記録されるファイル |
node_modules |
インストールしたモジュール本体が配置されるフォルダー |
dependencies |
本番環境で使用する（コードを実行する際に必要となる）パッケージ |
devDependencies |
開発環境で使用する（コードを実行する際に必要としない）パッケージ |
Yarnを使用したパッケージのインストール方法
npm公式サイトからパッケージを検索します。
インストールしたいパッケージのページ右側のinstall欄のコマンドを確認します。
installコマンドをyarn用に変更し、コマンドプロンプトで実行します。
（package.jsonを作成していない場合はインストール前にyarn initを実行する。）
# package.jsonを作成（作成していない場合）
yarn init -y
# Reactをインストール
yarn add react
npmコマンドとの対比
| Yarn | npm |
|---|---|
yarn init |
npm init |
yarn install |
npm i |
yarn add <package> |
npm i <package> |
yarn remove <package> |
npm r <package> |
yarn upgrade <package> |
npm up <package> |
yarn upgrade |
npm up |
yarn list |
npm ls |
Yarnの主なコマンド
| コマンド | 内容 |
|---|---|
yarn init |
カレントディレクトリにpackage.jsonを作成 |
yarn install |
package.jsonの内容にしたがってインストール |
yarn add <package> |
パッケージをインストール |
yarn remove <package> |
パッケージをアンインストール |
yarn upgrade <package> |
パッケージをアップデート |
yarn upgrade |
すべてのパッケージをアップデート |
yarn list |
インストールしたパッケージ一覧を表示 |
その他のコマンドは以下をご参照ください。
コマンド例
新規プロジェクト作成
# 対話形式でpackage.jsonファイルを作成
yarn init
# デフォルトパラメータで（対話なしで）package.jsonファイルを作成
yarn init -y
パッケージのインストール
# グローバルインストール
yarn global add <package>
# dependenciesにインストール（ローカルインストール）
yarn add <package>
# devDependenciesにインストール（ローカルインストール）
yarn add <package> -D
- 🔖 グローバルインストール
- パッケージはnpmのルート配下の
node_modulesにインストールされ、すべてのディレクトリでインストールしたパッケージを使用できます。 - 🔖 ローカルインストール
- パッケージはコマンドを実行したディレクトリ配下の
node_modulesにインストールされ、対象のディレクトリでのみインストールしたパッケージを使用できます。
コードを実行する際に必要となるパッケージ（React、Angular等）はdependencies、
コードを実行する際に必要とならないパッケージ（Mocha、Babel等）はdevDependenciesにインストールします。
プロジェクトの複製
# package.jsonに記載されたパッケージをすべてインストール
yarn install
# package.jsonの「dependencies」のみインストール
yarn install --prod
パッケージのアップデート
# ローカルインストールしたパッケージをアップデート
yarn upgrade <package>
# グローバルインストールしたパッケージをアップデート
yarn global upgrade <package>
パッケージ名を省略した場合はすべてのパッケージをアップデートします。
# ローカルインストールしたすべてのパッケージをアップデート
yarn upgrade
# グローバルインストールしたすべてのパッケージをアップデート
yarn global upgrade
パッケージのアンインストール
# ローカルインストールしたパッケージをアンインストール
yarn remove <package>
# グローバルインストールしたパッケージをアンインストール
yarn global remove <package>
パッケージ一覧を表示
# ローカルインストールしたパッケージ一覧を表示
yarn list --depth=0
# グローバルインストールしたパッケージ一覧を表示
yarn global list --depth=0
