More than 5 years have passed since last update.

yarnの使いかた

Last updated at 2019-10-03Posted at 2017-06-22

yarnとは

yarnはパッケージマネージャー。https://yarnpkg.com/en/
nodeをインストールすると自動でインストールされるnpmと役割は同様。
ただ、並行処理でのインストールによってnpmよりも高速にパッケージをインストールできる。

新しいプロジェクトを始める際に

yarn init

プロジェクトに対してのパッケージの追加方法


yarn add パッケージ名
yarn add パッケージ名@バージョン #バージョンを指定してパッケージのインストール
yarn add パッケージ名@タグ # これはいったい、、、

プロジェクトではなく、グローバルにパッケージの追加方法
◯◯-cliのようなパッケージをよくグローバルに追加するような気がします。

yarn global add パッケージ名

yarn upgrade パッケージ名
yarn upgrade パッケージ名@バージョン
yarn upgrade パッケージ@tag

yarn remove パッケージ名

yarn

ドキュメントの通り

yarnを追加したいディレクトリで以下を実行

yarn init

実行すると、対話形式でyarnの追加が始まる
何も入力しなくても良いし、しても良い。

name (your-project):
version (1.0.0):
description:
entry point (index.js):
git repository:
author:
license (MIT):

質問に答え終わったらpackage.jsonが作成されている。
質問に答えた内容で最低限のpackage.jsonが作られている。
自分だとこんな感じになってた。

package.json

{
  "name": "webpack-demo",
  "version": "1.0.0",
  "main": "index.js",
  "author": "kyohei",
  "license": "MIT"
}

package.jsonにはアプリケーションの情報を保存していく。
保存する情報で最も重要なのは、アプリケーションにインストーする必要があるパッケージ（と依存関係）。

別のパッケージを使用する場合は、そのパッケージを依存関係として追加する必要がある。
先に紹介したパッケージを追加するコマンドを実行する。

yarn add パッケージ

実行するとpackage.jsonに依存関係を追加する。
同時に依存を反映させたyarn.lockも更新される。

yarn.lockは、誰でも同じバージョンの依存をインストールできるように各依存のバージョンを管理するファイル。
add, upgrade, removeなどのyarnコマンドを実行すると自動でyarn.lockも更新される。

yarn installは、アプリケーションにすべての依存をインストールするために行う。
pacakge.jsonを元に依存のインストールを行い、yarn.lockでバージョンを管理する。

オプションもいくつかあるよ
実際に使うときに詳しく調べる
https://yarnpkg.com/en/docs/installing-dependencies

パッケージを管理するには、以下のファイルをソース管理（git）に置く必要がある。

yarnはビルドを早めるためにyarnのキャッシュディレクトリは全体に保存できる。

package.jsonのscriptsに定義したことを実行してくれる。

package.json

{
  "name": "my-package",
  "scripts": {
    "build": "babel src -d lib",
    "test": "jest"
  }
}

このようにすると、ターミナルで以下のようにして実行できる。

yarn run test

以下と同義

yarn run jest

引数も渡せる。

yarn run test -- -o --watch

node_modules/.bin/の中にローカルインストールされた実行可能ファイルもscriptsに書ける。

161