如何安装和使用Node.js的Yarn包管理器

介绍

Yarn是一个针对Node.js的包管理器,专注于速度、安全性和一致性。它最初是为了解决流行的NPM包管理器的一些问题而创建的。尽管这两个包管理器在性能和功能上已经趋于一致,但Yarn仍然很受欢迎,特别是在React开发领域。

Yarn的一些独特特性包括:

  • A per-project caching mechanism, that can greatly speed up subsequent installs and builds
  • 一致、确定性的安装,保证安装的库的结构始终相同
  • 对所有软件包进行校验和测试,以验证其完整性
  • “工作区”,有助于在单一源代码存储库中使用Yarn(多个项目的开发)

在本教程中,您将全局安装Yarn,将Yarn添加到特定项目中,并学习一些基本的Yarn命令。

使用DigitalOcean App Platform从GitHub部署您的前端应用程序。让DigitalOcean专注于扩展您的应用程序。

安装和使用Node.js的Yarn软件包管理器

  1. 全局安装Yarn
  2. 在您的项目中安装Yarn
  3. 使用Yarn

先决条件

在安装和使用Yarn软件包管理器之前,您需要先安装Node.js。要查看是否已安装Node.js,请在本地命令行终端中输入以下命令:

  1. node -v

如果您看到打印出的版本号,例如v12.16.3,则表示您已安装了Node.js。如果您收到“命令未找到”(或类似的措辞)错误,请在继续之前安装Node.js。

安装 Node.js,请按照我们的教程适用于 Ubuntu, Debian, CentOS, 或者 macOS

一旦您安装了 Node.js,请按照步骤 1 安装 Yarn 包管理器。

步骤 1 — 全局安装 Yarn

Yarn 有一种独特的方式在您的 JavaScript 项目中安装和运行。首先,您全局安装 yarn 命令,然后使用全局 yarn 命令将特定的本地版本 Yarn 安装到您的项目目录中。这是必要的,以确保所有参与项目的人(以及所有项目的自动化测试和部署工具)都运行相同版本的 yarn,以避免不一致的行为和结果。Yarn 的维护者建议使用包含在所有 Node.js 安装中的 NPM 包管理器全局安装 Yarn。使用 npm install 命令的 -g 标志来执行此操作:

Yarn维护者建议通过使用默认包含在所有Node.js安装中的NPM包管理器,将Yarn全局安装。使用npm install命令时加上-g标志来完成此操作:

  1. sudo npm install -g yarn

安装包之后,让yarn命令打印其自身的版本号。这将使您能够验证它是否已正确安装:

  1. yarn --version
Output
1.22.11

现在您已经全局安装了yarn命令,您可以使用它将Yarn安装到特定的JavaScript项目中。

第2步 – 在您的项目中安装Yarn

如果您正在使用Yarn与现有的基于Yarn的项目合作,可以跳过此步骤。该项目应该已经设置好了本地版本的Yarn以及使用它所需的所有配置文件。

如果您正在设置自己的新项目,现在您将希望配置项目特定的Yarn版本。

首先,导航到您的项目目录:

  1. cd ~/my-project

如果您没有项目目录,可以使用mkdir创建一个新的,然后移动到该目录:

  1. mkdir my-project
  2. cd my-project

现在使用yarn set命令将版本设置为berry

  1. yarn set version berry

这将下载当前正在积极开发的Yarn版本 – berry – 将其保存到项目的.yarn/releases/目录中,并设置一个.yarnrc.yml配置文件:

Output
Resolving berry to a url... Downloading https://github.com/yarnpkg/berry/raw/master/packages/berry-cli/bin/berry.js... Saving it into /home/sammy/my-project/.yarn/releases/yarn-berry.cjs... Updating /home/sammy/my-project/.yarnrc.yml... Done!

现在再次尝试运行yarn --version命令:

  1. yarn --version
Output
3.0.0

您将看到版本号为3.0.0或更高。这是Yarn的最新版本。

注意:如果您cd退出项目目录并再次运行yarn --version,您将再次获得全局Yarn的版本号,在这种情况下是1.22.11。每次运行yarn时,您都在使用全局安装的命令版本。全局yarn命令首先检查它是否位于具有.yarnrc.yml文件的Yarn项目目录中,如果是,它会将命令传递给项目特定版本的Yarn,该版本在项目的yarnPath设置中配置。

您的项目现在已设置为使用项目特定的Yarn版本。接下来,我们将查看一些常用的yarn命令来开始使用。

使用Yarn

Yarn有许多子命令,但您只需要几个就可以开始。让我们看看您想首先使用的第一个子命令。

获取帮助

在开始使用任何新工具时,了解如何访问其在线帮助很有用。在Yarn中,可以将--help标志添加到任何命令以获取更多信息:

  1. yarn --help

这将打印出yarn命令的总体帮助信息。要获取关于子命令的更具体信息,可以在子命令后添加--help

  1. yarn install --help

这将打印出关于如何使用yarn install命令的详细信息。

开始一个新的Yarn项目

如果你是从头开始一个项目,使用init子命令来创建你需要Yarn特定的文件:

  1. yarn init

这将添加一个package.json配置文件和一个yarn.lock文件到你的目录中。package.json包含了配置和你的模块依赖列表。yarn.lock文件锁定这些依赖到特定的版本,确保依赖树始终保持一致。

安装项目的所有依赖

要下载并安装现有Yarn项目中的所有依赖,使用install子命令:

  1. yarn install

这将下载并安装你开始项目所需的模块。

向项目中添加新的依赖项

使用add子命令向项目中添加新的依赖项:

  1. yarn add package-name

这将下载模块,安装它,并更新您的package.jsonyarn.lock文件。

为Yarn更新您的.gitignore文件

Yarn将文件存储在项目目录中的.yarn文件夹内。其中一些文件应该被纳入版本控制,而其他文件则应该被忽略。Yarn的基本.gitignore配置如下:

.gitignore
.yarn/*
!.yarn/patches
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*

这忽略了整个.yarn目录,然后添加了一些重要文件夹的例外,包括包含您项目特定的Yarn版本的releases目录。

有关如何配置Git和Yarn的更多详细信息,请参考官方Yarn文档中的.gitignore

结论

在本教程中,您安装了 Yarn 并学习了一些yarn子命令。有关使用 Yarn 的更多信息,请查阅官方 Yarn CLI 文档

如果您需要更多关于 Node.js 和 JavaScript 的帮助,请访问我们的Node.jsJavaScript标签页面,在那里您将找到相关的教程、技术讨论和社区问答。

Source:
https://www.digitalocean.com/community/tutorials/how-to-install-and-use-the-yarn-package-manager-for-node-js