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

介绍

Yarn是专注于速度、安全性和一致性的 Node.js的包管理器,最初是为了解决一些与受欢迎的 NPM包管理器相关的问题。

Yarn的一些独特特点是:

  • 每个项目的缓存机制,可以大大加快后续安装和构建
  • 保证安装库的结构始终相同的一致、确定性的安装
  • 对所有包进行检查,以验证其完整性
  • 工作空间,这有助于使用 Yarn 在一个 monorepo (在单一源代码库中开发的多个项目)

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

前提条件

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

1node -v

如果您看到版本号,如v12.16.3印刷,则已安装 Node.js. 如果您收到命令未找到错误(或类似的短语),请在继续之前安装 Node.js。

要安裝 Node.js,請遵循我們的教程 Ubuntu, Debian, CentOS,或 macOS

一旦安装了 Node.js,请转到步骤 1 来安装 Yarn 包管理器。

步骤 1 – 全球安装铁路

Yarn 在您的 JavaScript 项目中具有独特的安装和运行方式. 首先,您在全球范围内安装yarn命令,然后使用全球yarn命令将特定本地版本的 Yarn 安装到您的项目目录中。

Yarn 维护者建议使用 NPM 包管理器在全球范围内安装 Yarn,该软件默认情况下包含在所有 Node.js 安装中。

1sudo npm install -g yarn

软件包安装后,让yarn命令打印自己的版本号,这样你就可以验证它是正确安装的:

1yarn --version
1[secondary_label Output]
21.22.11

现在你已经在全球范围内安装了yarn命令,你可以使用它来将Yarn安装到特定JavaScript项目中。

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

如果您正在使用 Yarn 来处理现有基于 Yarn 的项目,您可以跳过此步骤,该项目应该已经设置了 Yarn 的本地版本和所有使用该项目所需的配置文件。

如果您正在创建一个新的项目,您现在需要配置一个项目特定的版本的 Yarn。

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

1cd ~/my-project

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

1mkdir my-project
2cd my-project

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

1yarn set version berry

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

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

现在再试试「yarn --version」命令:

1yarn --version
1[secondary_label Output]
23.0.0

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

<$>[note] ** 注意:** 如果您从项目目录中cd并再次运行yarn --version,您将再次获得 global Yarn 的版本号,在这种情况下,1.22.11。每次运行yarn时,您将使用全球安装的命令版本。全球yarn命令首先检查它是否在一个 Yarn 项目目录中具有.yarnrc.yml文件,如果是,则将命令发送到项目配置中的yarnPath版本。

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

使用铁

Yarn 有许多子命令,但你只需要几个才能开始,让我们看看你想要使用的第一个子命令。

得到帮助

开始使用任何新工具时,有助于学习如何访问其在线帮助. 在 Yarn 中,可以将帮助旗帜添加到任何命令中以获取更多信息:

1yarn --help

这将打印yarn命令的整体帮助. 若要获取有关子命令的更多具体信息,请在子命令后添加--help:

1yarn install --help

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

启动一个新的Yarn项目

如果您正在从头开始项目,请使用init子命令创建您需要的 Yarn 特定的文件:

1yarn init

这将为您的目录添加一个package.json配置文件和一个yarn.lock文件。package.json包含配置和您的模块依赖列表。

安装一个项目的所有依赖

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

1yarn install

这将下载和安装你需要开始的模块。

向项目添加新的依赖性

使用添加子命令为项目添加新依赖:

1yarn add package-name

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

更新您的 .gitignore 檔案為 Yarn

Yarn 将文件存储在您的项目目录中的 .yarn 文件夹中. 其中一些文件应该被检查到版本控制中,而其他应该被忽视。

1[label .gitignore]
2.yarn/*
3!.yarn/patches
4!.yarn/releases
5!.yarn/plugins
6!.yarn/sdks
7!.yarn/versions
8.pnp.*

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

有关如何配置 Git 和 Yarn 的更多细节,请参阅 .gitignore 的官方 Yarn 文档

结论

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

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

Published At
Categories with 技术
comments powered by Disqus