重要提示:本文档适用于 Yarn 1(经典版)。
有关 Yarn 2+ 文档和迁移指南,请参阅 yarnpkg.com。

yarn install

yarn install 用于安装项目的所有依赖项。这通常在以下情况下使用:当你刚刚签出项目的代码,或者项目中的另一名开发者添加了一个需要拾取的新依赖项。

如果你习惯使用 npm,你可能希望使用 --save--save-dev。这些已经被 yarn addyarn add --dev 代替。如需了解更多信息,请参阅 yarn add 文档

yarn 运行时不带命令将会运行 yarn install,并传递任何提供的标志。

如果你需要可重现的依赖项,通常在连续集成系统中会出现这种情况,则应该传递 --frozen-lockfile 标志。

yarn install

安装 package.json 中列出的所有依赖项,这些依赖项位于本地的 node_modules 文件夹中。

yarn.lock 文件使用方法如下

  • 如果存在 yarn.lock 且足以满足 package.json 中列出的所有依赖项,将会安装在 yarn.lock 中记录的确切版本,并且 yarn.lock 将保持不变。Yarn 将不会检查较新版本。
  • 如果不存在 yarn.lock,或者不足以满足 package.json 中列出的所有依赖项(例如,如果你手动将一个依赖项添加到 package.json),Yarn 将会查找可用的最新版本,以满足 package.json 中的约束。结果将写入 yarn.lock

如果你想确保不会更新 yarn.lock,请使用 --frozen-lockfile

yarn install --check-files

验证 node_modules 中已安装的文件没有被移除。

yarn install --flat

安装所有依赖项,但只允许每个软件包有一个版本。在首次运行时,这会提示你为以多个版本范围依赖的每个软件包选择一个版本。这些软件包将被添加到你的 package.json 中的 resolutions 字段下。

"resolutions": {
  "package-a": "2.0.0",
  "package-b": "5.0.0",
  "package-c": "1.5.2"
}
yarn install --force

这将重新获取所有软件包,即使是之前已安装的软件包。

yarn install --har

在安装过程中输出 HTTP 存档,从中记录所有网络请求。HAR 文件通常用于调查网络性能,并可以使用多种工具进行分析,例如 Google 的 HAR 分析器HAR 查看器

yarn install --ignore-scripts

不执行项目 package.json 及其依赖项中定义的任何脚本。

yarn install --modules-folder <path>

指定 node_modules 目录的备用位置,而不是默认的 ./node_modules

yarn install --no-lockfile

不读取或生成 yarn.lock 锁定文件。

yarn install --production[=true|false]

如果 NODE_ENV 环境变量设置为 production,则 Yarn 将不会安装 devDependencies 中列出的任何软件包。使用此标记指示 Yarn 忽略 NODE_ENV,而是从此标记获取其是否为生产状态。

注意: --production--production=true 相同。 --prod--production 的别名。

yarn install --pure-lockfile

不生成 yarn.lock 锁定文件。

yarn install --focus

在软件包的同级工作区依赖项下(在其 node_modules 文件夹下方)进行浅层安装。这允许你在不构建其他依赖的工作区的情况下运行该工作区。

必须在工作区项目中的单个工作区内部运行。不能在非工作区项目或工作区项目的根目录中运行。

了解有关聚焦工作区的更多信息。

yarn install --frozen-lockfile

不生成 yarn.lock 锁定文件,并且如果需要更新,则会失败。

yarn install --silent

运行 yarn install,而不打印安装日志。

yarn install --ignore-engines

忽略引擎检查。

yarn install --ignore-optional

不安装可选依赖项。

yarn install --offline

在离线模式下运行 yarn install。

yarn install --non-interactive

禁用交互式提示,例如当某个依赖项的版本无效时。

yarn install --update-checksums

如果 yarn.lock 锁定文件中的校验和与软件包的校验和不匹配,则更新锁定文件中的校验和。

yarn install --audit

检查已安装软件包的已知安全问题。找到的问题计数将添加到输出。使用 yarn audit 命令以获得更多详细的信息。与每次安装时都会自动运行 audit 的 npm 不同,yarn 将仅在需要时执行此操作。(随着功能验证的稳定性,这可能会在以后的更新中得到改变。)

防止 yarn 为程序包可能包含的任何二进制文件创建符号链接。

创建到 node_modules 中重复模块的硬链接。

yarn install --verbose

在安装依赖项时显示更多日志