Yarn 1 常用命令

[kiinlam]

基础

默认行为

安装 package.json 中的依赖

yarn
# 等于
yarn install

执行 script

尝试执行 package.json 的 script

yarn <script> [<args>]
# 等于
yarn run <script> [<args>]

执行 command

尝试执行本地安装的 CLI command

yarn <command> [<args>]

显示更多信息

yarn <command> --verbose

升级 yarn

npm install --global yarn

常用命令

yarn add

安装指定包

yarn add <package...>

安装依赖包 dependencies

可指定具体版本或标签包

yarn add package-name
yarn add package-name@1.2.3
yarn add package-name@tag

指定源位置

yarn add file:/path/to/local/folder
yarn add file:/path/to/local/tarball.tgz
yarn add link:/path/to/local/folder
yarn add <git remote url>
yarn add <git remote url>#<branch/commit/tag>
yarn add https://my-project.org/package.tgz

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

安装开发依赖 devDependencies

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

安装对等依赖 peerDependencies

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

安装可选依赖 optionalDependencies

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

安装完全匹配的版本

yarn add foo@1.2.3 // 可接受安装版本 1.9.1
yarn add foo@1.2.3 --exact // 仅接受安装版本 1.2.3

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

安装指定 minor version 的版本

yarn add foo@1.2.3 --tilde // 接受安装版本 1.2.9，但不支持 1.3.0

yarn add <alias-package>@npm:<package>

以指定别名的方式安装npm包

// 安装 foo 包，命名为 my-foo
yarn add my-foo@npm:foo@1.0.1

yarn create

从任意 create-* 脚手架创建项目

yarn create <starter-kit-package> [<args>]

# 执行
yarn create react-app my-app
# 等于执行了以下两个命令
yarn global add create-react-app
create-react-app my-app

yarn global

全局安装包

yarn global <add/bin/list/remove/upgrade> [--prefix]

prefix 参数用于指定路径前缀

yarn global dir 将显示全局包的安装位置

yarn info

显示包信息

yarn info <package> [<field>]

yarn info react
yarn info react --json
yarn info react@15.3.0
yarn info react description
yarn info react versions
yarn info react time
yarn info react readme

yarn init

生成 package.json 文件

# 使用默认值
yarn init --yes/-y

# 创建私有包
yarn init --private/-p

# 使用默认值创建私有包
$ yarn init -yp

yarn install

安装依赖包

# 重新拉取所有包
yarn install --force

# 只安装生产依赖
yarn install --production
yarn install --prod

yarn link 与 yarn unlink

将外部包链接到当前项目，需要两个步骤：

1. yarn link：在需要被引用的包文件夹下创建符号链接
2. yarn link [package...]：在使用外部包的项目文件夹下引用符合链接

假设有两个同层级文件夹 react 跟 react-relay，过程如下

1. 创建符合链接

$ cd react
$ yarn link
yarn link vx.x.x
success Registered "react".
info You can now run `yarn link "react"` in the projects where you want to use this module and it will be used instead.

2. 引用符合链接

$ cd ../react-relay
$ yarn link react
yarn link vx.x.x
success Registered "react".

取消符号链接步骤：

1. 在包文件夹下使用 yarn unlink 取消之前创建的符号链接

2. 在项目文件夹下使用 yarn unlink [package] 移除符号链接

3. 重新安装移除的包 yarn install --check-files

4. 取消符号链接

$ cd react
$ yarn unlink
yarn link vx.x.x
success Unregistered "react".

2. 移除符号链接

$ cd ../react-relay
$ yarn unlink react
yarn link vx.x.x
success Unregistered "react".

3. 验证安装

yarn install --check-files

yarn list

显示已安装的包，可指定匹配规则

yarn list [--depth] [--pattern]

yarn list --depth=0

yarn list --pattern <pattern>

yarn list --pattern gulp
yarn list --pattern "gulp|grunt"
yarn list --pattern "gulp|grunt" --depth=1

yarn outdated

显示落后的依赖包

yarn outdated [package...]

显示指定包的更新版本

yarn outdated lodash

yarn remove

移除依赖包，并更新 package.json 和 yarn.lock

yarn run

yarn run [script] [<args>]

执行指定 script，未指定名称时，列出所有可用的 script

[script] 可以是本地 node_modules/.bin/ 安装的任意可执行文件

run 命令关键词可省略，如

yarn test -o --watch
# 等于
yarn run test -o --watch

注意：省略 run 时，如果 [script] 与某个 CLI command 匹配时，将执行该命令，而不是执行 package.json 中的 script

[script] 可添加前缀 pre 和后缀 post，如：

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

执行 yarn build 时，会先执行 prebuild

yarn run env

package.json 中没有指定 script/env 时，列出 script 的运行时环境变量

yarn upgrade 与 yarn upgrade-interactive

基于指定版本范围升级指定包到最新版本，版本范围可在 package.json 文件指定，未指定包名时，升级所有依赖包

yarn upgrade [package | package@tag | package@version | --scope @scope]... [--ignore-engines] [--pattern]

yarn upgrade
yarn upgrade left-pad
yarn upgrade left-pad@^1.0.0
yarn upgrade left-pad grunt
yarn upgrade @angular

yarn upgrade [package]... --latest|-L [--caret | --tilde | --exact] [--pattern]

使用 --latest 来强制升级到 latest 标签对应的版本

yarn upgrade (--scope|-S) @scope [--latest] [--pattern]

使用 --scope @scope 来升级指定 scope 下的包

yarn upgrade-interactive [--latest]

通过命令行交互式升级包

[1/? Choose which packages to update. (Press <space> to select, <a> to toggle all, <i> to inverse s
election)
 devDependencies
❯◯ autoprefixer      6.7.7  ❯  7.0.0          https://github.com/postcss/autoprefixer#readme
 ◯ webpack           2.4.1  ❯  2.5.1          https://github.com/webpack/webpack

 dependencies
 ◯ bull              2.2.6  ❯  3.0.0-alpha.3  https://github.com/OptimalBits/bull#readme
 ◯ fs-extra          3.0.0  ❯  3.0.1          https://github.com/jprichardson/node-fs-extra
 ◯ socket.io         1.7.3  ❯  1.7.4          https://github.com/socketio/socket.io#readme
 ◯ socket.io-client  1.7.3  ❯  1.7.4          https://github.com/Automattic/socket.io-client#readme

yarn version

在命令行中交互式更新 package.json 中的 version 字段

version 规则：major.minor.patch-labels，如 2.0.0-beta.3

yarn why

显示指定包为何被安装，如间接依赖或直接依赖

<query> 可以是一个包名，或是包文件夹，或是文件路径

yarn why jest
yarn why node_modules/jest
yarn why node_modules/jest/index.js

参考

Yarn 1 doc