yarnコマンド チートシート

yarn init

オプション:

• -y / --yes: すべての質問にデフォルト値で回答し、対話をスキップします。
• -p / --private: private: true を package.json に追加し、誤って公開されるのを防ぎます。

# デフォルト値で初期化
yarn init -y

# 最新安定版に設定
yarn set version stable

# 特定のバージョンに設定
yarn set version 3.2.0

# 最新のリリース候補版に設定
yarn set version rc

# canary ビルドに設定
yarn set version canary

# ローカルの yarn リリースファイルから設定
yarn set version /path/to/yarn.js

# 単一パッケージを追加
yarn add react

# 複数パッケージを追加
yarn add lodash moment

# 特定バージョンを追加
yarn add react@17.0.2

# タグ指定で追加 (例: next)
yarn add typescript@next

主なオプション:

• -D / --dev: devDependencies (開発環境用依存) として追加します。
• -P / --peer: peerDependencies (ピア依存) として追加します。
• -O / --optional: optionalDependencies (オプショナル依存) として追加します。
• -E / --exact: バージョン番号を固定して (例: 1.2.3) 追加します。
• -T / --tilde: チルダ (~) 範囲で (例: ~1.2.3) 追加します。
• --ignore-scripts: パッケージのインストール後スクリプトを実行しません。

# 開発依存として追加
yarn add -D jest

# ピア依存として追加
yarn add -P react

# バージョン固定で追加
yarn add -E axios

Yarn Berry (v2+) 特有:

• -i / --interactive: 依存関係の解決に関する詳細な対話モードを開始します。

yarn install

主なオプション:

• --force: ローカルキャッシュを無視して、すべてのパッケージを再ダウンロードします。
• --production: devDependencies を含めず、本番環境用の依存のみをインストールします。
• --frozen-lockfile (v1) / --immutable (v2+): ロックファイルを変更せずにインストールします。変更が必要な場合はエラーになります (CI環境で有用)。
• --check-files: 既にインストールされているファイルが存在するか確認します。
• --ignore-scripts: インストール後スクリプトを実行しません。
• --modules-folder <path> (v1): node_modules ディレクトリの場所を指定します。
• --no-lockfile: ロックファイルを生成・更新しません (非推奨)。

# CI 環境でのインストール (ロックファイルを変更しない)
# Yarn v1
yarn install --frozen-lockfile
# Yarn v2+
yarn install --immutable

# 本番用依存のみインストール
yarn install --production

# すべての依存を更新
yarn upgrade

# 特定のパッケージを更新
yarn upgrade react react-dom

# 特定のスコープのパッケージを更新
yarn upgrade --scope @babel

主なオプション:

• --latest: package.json のバージョン範囲指定を無視し、最新バージョンに更新しようとします。
• --pattern <pattern>: パターンに一致するワークスペース内のパッケージを更新します (ワークスペース使用時)。

# 最新メジャーバージョンも含めて更新
yarn upgrade --latest

yarn upgrade-interactive

主なオプション:

• --latest: 最新バージョンを更新候補として表示します。

# 単一パッケージを削除
yarn remove lodash

# 複数パッケージを削除
yarn remove moment date-fns

# パッケージ `my-local-library` のディレクトリで実行
cd /path/to/my-local-library
yarn link

# `my-app` プロジェクトのディレクトリで実行
cd /path/to/my-app
yarn link my-local-library

# `my-local-library` のリンクを解除 (my-local-library ディレクトリで)
yarn unlink

# `my-app` プロジェクトから `my-local-library` のリンクを解除 (my-app ディレクトリで)
yarn unlink my-local-library

# package-lock.json があるディレクトリで実行
yarn import

# "build" スクリプトを実行
yarn run build

# "test" スクリプトに引数を渡して実行
yarn run test --watch

run は省略可能な場合が多いです。

yarn build
yarn test --watch

# "start" スクリプトを実行
yarn start

# "lint" スクリプトを実行
yarn lint

# create-react-app を一時的に実行
yarn dlx create-react-app my-app

# 特定バージョンのパッケージを実行
yarn dlx cowsay@1.5.0 "Hello"

主なオプション:

• -p <package>: 実行するコマンドが含まれるパッケージ名を指定します。

yarn dlx -p prettier prettier --write .

# ローカルにインストールされた jest を実行
yarn exec jest --coverage

# node スクリプトを実行 (node が依存に含まれている場合)
yarn exec node my-script.js

Yarn Berry (v2+) では、yarn run が内部的に exec のような動作をするため、明示的な exec の必要性は減っています。

# react パッケージの情報を表示
yarn info react

# react パッケージの利用可能な全バージョンを表示
yarn info react versions

# react パッケージのライセンス情報を表示
yarn info react license

# lodash の最新バージョン情報を JSON 形式で表示
yarn info lodash version --json

主なオプション:

• --json: 出力を JSON 形式にします。

yarn list

主なオプション:

• --depth=<number>: 表示する依存関係の階層の深さを制限します。
• --pattern <pattern>: パターンに一致するパッケージのみを表示します。

# 依存関係のトップレベルのみ表示
yarn list --depth=0

# "react" を含むパッケージのみ表示
yarn list --pattern react

yarn outdated

# "lodash" がなぜインストールされているか確認
yarn why lodash

# 特定バージョンのパッケージがなぜ存在するか確認
yarn why @types/node@14.x

yarn licenses list

主なオプション:

• --production: 本番環境用の依存関係のみを対象にします。
• --json: 出力を JSON 形式にします。

yarn licenses generate-disclaimer

# すべてのキャッシュを削除
yarn cache clean

# 特定のパッケージのキャッシュを削除 (Yarn v1)
yarn cache clean react react-dom

Yarn Berry (v2+) では、キャッシュはプロジェクトごとに .yarn/cache に保存されるため、このディレクトリを直接削除することが推奨されます。

# Yarn v2+ でキャッシュを削除する場合
rm -rf .yarn/cache

yarn cache dir

# npm レジストリのスコープ設定
yarn config set npmScopes.my-org.npmRegistryServer "https://registry.my-org.com"

# init コマンドのデフォルト作成者を設定
yarn config set initAuthorName "My Name"

# プラグインのインポート (Yarn Berry)
yarn config set plugins --json '[{"path": ".yarn/plugins/@yarnpkg/plugin-typescript.cjs", "spec": "@yarnpkg/plugin-typescript"}]'

オプション:

• -H / --home: グローバル設定 (~/.yarnrc.yml) に書き込みます (Yarn Berry)。
• --json: 値を JSON として解析します。

# 現在のキャッシュフォルダの場所を取得
yarn config get cacheFolder

# init コマンドのデフォルトライセンス設定を取得
yarn config get initLicense

オプション:

• --json: 出力を JSON 形式にします。

# init コマンドのデフォルト作成者設定を削除
yarn config delete initAuthorName

# Node.js v14 以上を要求
yarn policies set-version ">=14"

# 特定の Yarn バージョンを要求 (あまり使われない)
# yarn policies set-version "1.22.x"

Yarn Berry (v2+) では yarn set version と Corepack、package.json の packageManager フィールドを使用します。

# "frontend" ワークスペースに lodash を追加
yarn workspace frontend add lodash

# "backend" ワークスペースで "build" スクリプトを実行
yarn workspace backend run build

# "shared-ui" ワークスペースから jest を削除
yarn workspace shared-ui remove jest

yarn workspaces list

# JSON 形式で出力
yarn workspaces list --json

# すべてのワークスペースで "build" スクリプトを実行 (並列)
yarn workspaces foreach run build

# すべてのワークスペースでテストを実行 (トポロジカル順、並列)
yarn workspaces foreach -pt run test

# "utils-" で始まるワークスペースのみで lint を実行
yarn workspaces foreach --include "utils-*" run lint

主なオプション:

• -p / --parallel: 並列実行 (デフォルト)。
• -s / --serial: 直列実行。
• -t / --topological: 依存関係の順序 (トポロジカル順) で実行。
• -v / --verbose: 詳細なログを出力。
• --include <pattern>: 指定したパターンに一致するワークスペースのみ対象。
• --exclude <pattern>: 指定したパターンに一致するワークスペースを除外。

# ルートに開発依存を追加 (全ワークスペースから利用可能になることがある)
yarn add -D -W typescript

# ルートから依存を削除
yarn remove -W some-package

Yarn Berry (v2+) では、ルートでの操作は明示的にルートに対して行われ、ワークスペース間の依存関係は各ワークスペース内で管理するのが基本です。

# TypeScript プラグインをインポート
yarn plugin import typescript

# Constraints プラグインをインポート
yarn plugin import constraints

# ローカルのプラグインファイルをインポート
yarn plugin import ./my-custom-plugin.js

# 特定の npm パッケージからプラグインをインポート
yarn plugin import from @yarnpkg/plugin-foo

yarn plugin list

オプション:

• --json: 出力を JSON 形式にします。

# TypeScript プラグインを削除
yarn plugin remove typescript

# ローカルのプラグインファイルを指定して削除
yarn plugin remove ./my-custom-plugin.js

yarn plugin runtime

# 現在のワークスペースのパッチバージョンを上げる
yarn version patch

# プロジェクト全体のマイナーバージョンを上げる
# (変更があったワークスペースのみ対象になることが多い)
yarn version minor

# バージョンアップをリリース時まで遅延させる
yarn version deferred

オプション:

• --deferred: バージョン更新を遅延させ、.yarn/versions に記録します。
• --immediate: 遅延させずに即座にバージョンを更新します (デフォルト)。

yarn version check

オプション:

• --interactive / -i: 矛盾が見つかった場合に、対話的に修正を選択できます。

# 遅延されたすべてのバージョン更新を適用
yarn versions apply --all

# 特定のバージョンファイルに基づいて適用
yarn versions apply 08e1e9a5.yml

オプション:

• --all: .yarn/versions 内のすべてのバージョンファイルを適用します。

yarn versions bump