Yarn 常用命令

Yarn 用法:

yarn [<command>] [<packages>] [<options>]

直接执行 yarn 等同于执行 yarn install

安装项目依赖

用法

yarn install [<options>]

解释

  • 在本地(当前目录) node_modules 安装 package.json 里列出的所有依赖。

[<options>]

  • --production :不安装 devDependencies 依赖。

初始化配置文件

用法

yarn init [<options>]

解释

  • 在本地初始化一个 package.json 文件。

options

  • --private :初始化时自动添加 private: truepackage.json 中。

添加本地依赖

用法

yarn add <packages> [<options>]

解释

  • 依赖默认会被添加到 package.json 配置文件的 dependencies 中,且会更新 yarn.lock 锁文件。
  • 依赖默认会被安装到本地(当前目录)的 node_modules 目录中。
  • 默认添加依赖的主要版本里的最新版。
  • 本地安装的依赖提供的命令无法直接在 shell 工具中b被执行,可以在 package.json 中的 scripts 中b被执行,或者在命令前面带上 node_modules/.bin/ 路径也可以被执行。

packages

  • 多个依赖用空格隔开。
  • 可使用 <package>@<version> 从 registry 中安装指定版本的依赖(如果没有可能会安装其他版本)。
  • 可使用 <package>@<tag> 从 registry 中安装指定标签的依赖(比如 betanext 或者 latest 等)。

options

  • --dev/-D :添加依赖到 devDependencies 中。
  • --exact/-E :精确安装指定版本的依赖,不接受任何其他版本。

本地移除依赖

用法

yarn remove <packages> [<options>]

解释

  • 默认会从 package.json 配置文件的 dependencies 中移除依赖,且会更新 yarn.lock 锁文件。
  • 依赖包文件会从本地(当前目录)的 node_modules 目录中被删除。
  • 多个依赖用空格隔开。

packages

  • yarn add <packages> [<options>]

options

  • --dev/-D :从 devDependencies 中移除依赖。

列出本地依赖

用法

yarn list [<options>]

解释

  • 列出当期本地(当前目录)所有依赖。

options

  • --depth=<number> :列出指定层级深度的依赖,层级深度从 0 开始。

  • --pattern=<keyword> :列出含有关键词的依赖。

    多个关键词用 | 隔开(如 yarn list --pattern="gulp|grunt" )。

升级本地依赖

用法

yarn upgrade [<packages>] [<options>]

解释

  • 不加依赖包名默认直接升级所有依赖。
  • 默认升级依赖到最新版本。

packages

  • 多个依赖用空格隔开。
  • 可使用 <package>@<version|tag> 升级依赖到指定版本(标签)。

options

  • --exact :精确升级依赖到指定版本。

管理全局依赖

用法

yarn global add|bin|list|remove|upgrade [<packages>] [<options>]

解释

  • 全局安装会将依赖包文件安装在系统的 node_modules 目录中。
  • 全局安装的依赖提供的命令可以在 shell 工具中直接被执行。
  • 命令用法同对应的本地命令用法。

执行 Npm Scripts

用法

yarn run [<script>] [<args>]

解释

  • 不加脚本名称默认列出所有可执行的脚本。
  • 加脚本名称执行 package.json 配置文件中定义在 scripts 中指定的 npm scripts。

scripts

  • 定义在 package.json 配置文件中的 scripts 中的脚本名称。

args

  • 执行 npm scripts 时会加上该参数执行。

参考文献