yarn add(翻译)

1,721 阅读3分钟

安装程序包及其所依赖的任何程序包。

添加依赖项

一般来说,包只是一个包含代码和package.json描述内容的文件。当您想使用另一个包时,首先需要将其添加到依赖项中。这意味着运行yarn add [package name]将其安装到您的项目中。

这也将更新您的package.json你的yarn.lock。这样其他开发人员在运行yarn或yarn install时将获得与您相同的依赖关系。

大多数软件包都是从npm注册表安装的,并且只需引用它们的包名。例如,yarn add react将从npm注册表安装react包。

可以使用以下选项之一指定版本:

  • yarn add package-name安装“最新”版本的包。

  • yarn add package-name@1.2.3从注册表安装包的特定版本。

  • yarn add package-name@tag安装特定的“标记”(例如beta、next或最新版本)。

还可以指定来自不同位置的包:

  • yarn add package-name从npm注册表安装包,除非您在package.json有特别的指定。
  • yarn add file:/path/to/local/folder安装本地文件系统上的包。这对于测试尚未发布到注册中心的其他包非常有用。
  • yarn add file:/path/to/local/tarball.tgz 安装一个 gzipped tarball 包 ,该包可用于在发布之前共享包。
  • yarn add link:/path/to/local/folder安装指向本地文件系统上的包的符号链接。这对于在monorepo环境中开发相关包非常有用。
  • yarn add从远程git存储库安装一个包。
  • yarn add<branch/commit/tag>从位于特定git分支、git提交或git标记的远程git存储库安装一个包。
  • yarn add my-project.org/package.tgz 从远程gzip压缩tarball安装包。

注意事项

如果您以前使用过像npm这样的包管理器,那么您可能正在寻找如何添加全局依赖项。

对于绝大多数包来说,拥有全局依赖关系被认为是不好的做法,因为它们是隐式的。最好在本地添加所有依赖项,以便它们是显式的,并且使用项目的任何其他人都可以获得相同的依赖集。

如果尝试使用具有bin的CLI工具,则可以在./node_modules/.bin目录中访问这些bin。也可以使用全局命令:

yarn global add <package...>

命令

yarn add <package...>

This will install one or more packages in your dependencies.

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

Using --dev or -D will install one or more packages in your devDependencies.

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

Using --peer or -P will install one or more packages in your peerDependencies.

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

Using --optional or -O will install one or more packages in your optionalDependencies.

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

使用--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]

使用--tilde或-T安装具有相同次要版本的最新版本的软件包。默认情况下,使用具有相同主版本的最新版本。例如,yarn add foo@1.2.3 --tilde接受1.2.9,但不接受1.3.0。

yarn add <package...> [--ignore-workspace-root-check/-W]

使用--ignore workspace root check或-W允许在工作区根目录下安装包。这往往不是理想的行为,因为依赖关系通常被认为是工作区的一部分。例如,yarn add lerna --ignore-workspace-root-check --dev 在工作区根目录下允许lerna在根 package.json中使用脚本.

yarn add @npm:

这将在自定义别名下安装包。别名,允许安装同一依赖项的多个版本,每个版本都通过给定的别名包名引用。例如,yarn add my-foo@npm:foo将在依赖项中的指定别名my foo下安装foo包(最新版本)。另外,yarn add my-foo@npm:foo@1.0.1允许安装特定版本的foo。

yarn add <package...> --audit

检查已安装软件包是否存在已知的安全问题。已发现问题的计数将添加到输出中。使用yarn audit命令获取更多详细信息。