从头开始:Yarn的安装和使用教程

发布时间:2024年01月23日

学习目标:

  1. 理解Yarn的作用和优势,以及与其他包管理工具的区别
  2. 学会在自己的系统上正确安装Yarn,并掌握各个操作系统的不同安装方法
  3. 熟悉Yarn的基本用法,能够创建新项目,添加和安装依赖,并了解如何更新依赖
  4. 掌握Yarn的高级用法,如发布和共享自己的包,以及如何管理多个项目
  5. 能够解决Yarn使用过程中遇到的常见问题和故障,提高自己的独立故障排除能力

学习内容:

  1. Yarn的介绍和背景知识
  2. Yarn的安装方法:包括在不同操作系统上的安装步骤
  3. Yarn的基本用法:如创建新项目、添加依赖、安装依赖、升级依赖等
  4. Yarn的高级用法:如发布和共享自己的包、使用Yarn Workspaces管理多个项目等
  5. Yarn的常见问题和故障排除:如网络问题、依赖冲突等

学习时间:

  • 周一至周五晚上 7 点—晚上9点
  • 周六上午 9 点-上午 11 点
  • 周日下午 3 点-下午 6 点

学习产出:

  1. Yarn的介绍和背景知识:

    • 了解Yarn的起源和由来

Yarn是由Facebook团队于2016年推出的开源软件包管理器。它的发展背景源于npm(Node Package Manager)在处理大型项目时性能和可靠性不足的问题。

在当时,随着前端项目的复杂性不断增加,npm在安装和管理依赖包时遇到了一些挑战。其中最主要的问题是,npm默认的依赖解析算法并不保证在不同环境中生成相同的依赖树,这可能导致项目在不同机器上构建时出现不一致的行为。此外,无论是网络连接速度慢还是依赖包下载的并发性能问题,都可能导致npm的速度缓慢。

为了解决这些问题,Facebook团队开发了Yarn。Yarn的目标是提供一个快速、可靠和安全的软件包管理解决方案,以满足大型项目的需求。Yarn采用了一种全新的依赖解析算法,可以确保在不同环境中生成完全相同的依赖树。此外,Yarn还引入了并行安装和缓存机制,以提高安装速度并减少对网络的依赖。

Yarn的推出在开发者社区引起了广泛的关注和采用,逐渐成为了许多开发团队的首选包管理器。除了解决了npm的一些问题,Yarn还提供了一些额外的功能,如锁定依赖版本、多仓库支持、自定义安装目录等,使得它更加灵活和易用。

总而言之,Yarn是一个由Facebook团队推出的包管理器,旨在通过提供更好的性能、可靠性和安全性来改进大型项目的依赖管理。它的起源源于对npm存在问题的认识和需求的追求。

    • 理解Yarn与npm之间的关系和区别

Yarn和npm是两种常用的JavaScript包管理工具。它们的目标是相同的:帮助开发人员管理和安装项目所需的依赖项。

下面是Yarn和npm之间的一些主要区别:

  1. 性能:Yarn在性能方面通常比npm更快。这是因为Yarn通过使用并行和缓存来提高安装依赖项的速度,而npm在处理大型项目时可能会变慢。

  2. 安装:npm在安装依赖项时会将每个依赖项的具体版本信息存储在package.json文件中,而Yarn则会将这些信息存储在yarn.lock文件中。这意味着当团队中的其他成员或其他机器上的开发人员运行yarn install命令时,Yarn将确保安装的依赖项版本与yarn.lock文件中的版本一致性。

  3. 可靠性:Yarn具有更强大的错误处理和更好的稳定性。当npm在安装依赖项时遇到错误时,它通常会中断并停止进程。相比之下,Yarn会报告错误并尝试通过运行安装的其他依赖项来恢复安装过程。

  4. 社区支持:npm在JavaScript社区中更为流行,并且有更广泛的社区支持和生态系统。这意味着npm上可能有更多的开源软件包和资源可供选择。但是,Yarn也在逐渐增长,并且有一些专门为Yarn设计的功能和插件。

总体而言,Yarn和npm都是有效的包管理工具,选择使用哪一个取决于您的个人喜好和项目需求。

    • 了解Yarn的优势和特点,如快速、可靠和安全等

当谈到Yarn的优势和特点时,以下是一些关键点:

  1. 快速:Yarn通过使用并行安装和缓存来提高安装依赖项的速度。这意味着在项目中使用Yarn安装依赖项时,可以显著提高安装速度。例如,如果多个依赖项可以并行安装,Yarn将同时下载它们,而不是按顺序一个一个地下载。

  2. 可靠:Yarn具有更强大的错误处理和更好的稳定性。当安装依赖项时,Yarn会使用yarn.lock文件确保安装的依赖项版本与文件中指定的版本一致。这种锁定机制可以确保在不同机器上或不同时间点进行安装时使用相同的依赖项版本,从而避免潜在的不兼容性问题。

  3. 安全:Yarn具有一些内置的安全功能,可以帮助开发人员维护项目的安全性。例如,Yarn会在安装依赖项时检查它们的完整性,以确保下载的软件包没有被篡改或损坏。此外,Yarn还提供了一个yarn audit命令,用于检查项目中的依赖项是否有已知的安全漏洞。

以下是一些关于Yarn优势和特点的具体例子:

  • 快速:由于Yarn在安装依赖项时使用并行和缓存,因此在较大的项目中使用Yarn可以比npm更快地安装依赖项。
  • 可靠:当在团队中的其他成员或其他机器上的开发人员运行yarn install命令时,Yarn会通过yarn.lock文件确保安装的依赖项版本一致。
  • 安全:Yarn提供了一个yarn audit命令,可以检查项目中的依赖项是否有已知的安全漏洞。这有助于开发人员及时发现并解决潜在的安全问题。
  1. Yarn的安装方法:

    • Windows系统上的安装方法

在Windows系统上安装Yarn的详细步骤如下:

  1. 访问Yarn官方网站(https://yarnpkg.com)并下载最新的Windows安装程序(.msi文件)。

  2. 双击下载的.msi文件以启动安装程序。

  3. 在安装程序的欢迎界面上,点击"Next"继续。

  4. 阅读并接受软件许可协议,然后点击"Next"。

  5. 选择要安装Yarn的目标文件夹,通常建议使用默认位置,然后点击"Next"。

  6. 在选择附加任务的界面上,可以选择是否创建快捷方式等选项。根据个人需求进行选择,然后点击"Next"。

  7. 在安装选项界面上,可以选择是否将Yarn添加到系统的环境变量中,以便在命令行中全局访问Yarn命令。根据个人需求进行选择,然后点击"Next"。

  8. 在准备安装界面上,确认安装选项,然后点击"Install"开始安装。

  9. 安装完成后,点击"Finish"退出安装程序。

  10. 打开命令提示符(CMD)或PowerShell,并运行yarn --version命令,以确认Yarn已成功安装。如果安装成功,将显示Yarn的版本号。

现在,您已经成功在Windows系统上安装了Yarn,并可以在项目中使用Yarn进行包管理。

    • macOS系统上的安装方法

在macOS系统上安装Yarn的步骤如下:

  1. 使用Homebrew(包管理器)安装Yarn。打开终端(Terminal)应用程序。

  2. 运行以下命令来安装Homebrew(如果尚未安装):

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

  1. 安装完Homebrew后,运行以下命令安装Yarn:
brew install yarn

  1. 当提示您输入密码时,请输入您的计算机密码并按Enter键。

  2. 安装程序将自动下载和安装Yarn及其所有依赖项。

  3. 安装完成后,在终端中运行以下命令以验证Yarn的安装:

yarn --version

  1. 如果安装成功,将显示Yarn的版本号。

现在,您已经成功在macOS系统上安装了Yarn,并可以在项目中使用Yarn进行包管理。

    • Linux系统上的安装方法

在Linux系统上安装Yarn的步骤如下(以Ubuntu为例):

  1. 打开终端(Terminal)应用程序。

  2. 首先,使用curl或wget下载Yarn的安装脚本。运行以下命令来下载脚本:

使用curl:

curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -

使用wget:

wget -qO- https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -

  1. 添加Yarn的APT存储库。运行以下命令:
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

  1. 更新系统的包信息并安装Yarn。运行以下命令:
sudo apt update
sudo apt install yarn

  1. 安装程序将自动下载和安装Yarn及其所有依赖项。

  2. 安装完成后,在终端中运行以下命令以验证Yarn的安装:

yarn --version

  1. 如果安装成功,将显示Yarn的版本号。

现在,您已经成功在Linux系统上安装了Yarn,并可以在项目中使用Yarn进行包管理。

  1. Yarn的基本用法:

    • 创建新的Yarn项目

要在Yarn中创建新项目,您可以按照以下步骤进行操作:

  1. 打开终端(Terminal)应用程序。

  2. 创建一个新的文件夹来存储项目文件。您可以选择在任何位置创建文件夹。例如,运行以下命令在当前目录下创建一个名为my-yarn-project的文件夹:

mkdir my-yarn-project

  1. 进入新创建的文件夹。运行以下命令:
cd my-yarn-project

  1. 使用Yarn初始化项目。运行以下命令:
yarn init

  1. 运行上述命令后,Yarn将会开始引导您通过一系列问题,以生成package.json文件。您可以根据需要回答这些问题,或者直接按回车键接受默认值。

  2. 当您完成回答所有问题后,Yarn将会生成一个包含项目配置信息的package.json文件。

现在,您已经成功创建了一个新的Yarn项目。在my-yarn-project文件夹中,您将看到生成的package.json文件,您可以在其中定义项目的依赖关系、脚本、版本等信息。您可以使用Yarn来安装项目的依赖项,运行脚本以及执行其他与包管理相关的操作。

    • 添加依赖到项目中

要将依赖项添加到Yarn项目中,请按照以下步骤操作:

  1. 打开终端(Terminal)应用程序。

  2. 导航到您的项目文件夹中。使用cd命令进入项目所在的文件夹。例如,如果项目位于my-yarn-project文件夹中,运行以下命令:

cd my-yarn-project

  1. 使用Yarn来添加依赖项。运行以下命令,将依赖项的包名作为参数传递给Yarn的add命令。
yarn add <package-name>

在上述命令中,将&lt;package-name>替换为您想要添加的依赖项的实际包名。您还可以使用@&lt;version>指定要添加的特定版本。例如,要将React添加为依赖项,您可以运行以下命令:

yarn add react

或者,如果您想要指定React的特定版本,您可以运行以下命令:

yarn add react@16.8.0

  1. 运行上述命令后,Yarn将会下载所需的依赖项并将它们添加到您的项目中的node_modules文件夹中。它还会将依赖项的信息添加到package.json文件中的dependencies部分。

您可以重复运行上述命令,以添加更多的依赖项到您的项目中。Yarn会自动处理依赖项之间的版本冲突,并确保它们按正确的顺序安装。

现在,您已成功向Yarn项目添加了依赖项。您可以在项目文件夹中的package.json文件中查看所有已添加的依赖项,并在需要时使用它们。

    • 安装项目的依赖

要安装项目的依赖项,请按照以下步骤操作:

  1. 打开终端(Terminal)应用程序。

  2. 导航到您的项目文件夹中。使用cd命令进入项目所在的文件夹。例如,如果项目位于my-project文件夹中,运行以下命令:

cd my-project

  1. 运行以下命令,使用Yarn安装项目的依赖项:
yarn install

或者,您也可以使用以下命令来简化安装过程:

yarn

  1. 运行上述命令后,Yarn将会读取您的项目中的package.json文件,并下载并安装所有列在dependenciesdevDependencies部分的依赖项。它们将被安装在项目文件夹的node_modules目录中。

请注意,在运行yarn install命令之前,确保您已经在项目文件夹中正确地设置了package.json文件,并使用yarn init或手动编辑该文件来定义项目的依赖项。

一旦所有依赖项被成功安装,您就可以在项目中使用它们了。

    • 更新项目的依赖

要更新项目的依赖项,请按照以下步骤操作:

  1. 打开终端(Terminal)应用程序。

  2. 导航到您的项目文件夹中。使用cd命令进入项目所在的文件夹。例如,如果项目位于my-project文件夹中,运行以下命令:

cd my-project

  1. 运行以下命令,使用Yarn更新项目的依赖项:
yarn upgrade

或者,您可以指定要更新的特定依赖项。例如,如果要更新lodash依赖项,运行以下命令:

yarn upgrade lodash

  1. 运行上述命令后,Yarn将会读取您的项目中的package.json文件,并检查当前安装的依赖项与package.json文件中定义的版本要求是否匹配。如果有任何依赖项需要更新,Yarn将下载并安装最新版本。

请注意,根据package.json文件中的依赖版本约束,可能不会自动更新主要版本之间的不兼容更改。如果要更新所有依赖项的最新版本,而不考虑约束,请使用以下命令:

yarn upgrade --latest

一旦所有依赖项被成功更新,您就可以在项目中使用它们了。

    • 移除项目的依赖

要移除项目的依赖项,请按照以下步骤操作:

  1. 打开终端(Terminal)应用程序。

  2. 导航到您的项目文件夹中。使用cd命令进入项目所在的文件夹。例如,如果项目位于my-project文件夹中,运行以下命令:

cd my-project

  1. 运行以下命令,使用Yarn移除项目的依赖项:
yarn remove <dependency>

&lt;dependency>替换为您要移除的实际依赖项的名称。例如,如果要移除lodash依赖项,运行以下命令:

yarn remove lodash

  1. 运行上述命令后,Yarn将会从您的package.json文件和node_modules文件夹中移除指定的依赖项。

请注意,移除依赖项可能会导致其他依赖项不可用或出现冲突。在移除依赖项之前,请确保已经了解它们之间的依赖关系以及可能的影响。

    • 运行项目中的脚本命令

要运行项目中的脚本命令,请按照以下步骤操作:

  1. 打开终端(Terminal)应用程序。

  2. 导航到您的项目文件夹中。使用cd命令进入项目所在的文件夹。例如,如果项目位于my-project文件夹中,运行以下命令:

cd my-project

  1. 运行以下命令,使用Yarn运行脚本命令:
yarn run <script>

&lt;script>替换为您要运行的实际脚本命令的名称。例如,如果要运行名为start的脚本命令,运行以下命令:

yarn run start

  1. 运行上述命令后,Yarn将查找并执行项目中的指定脚本命令。

请注意,脚本命令可以在项目的package.json文件中定义。在运行脚本命令之前,请确保已经了解它们的用途和预期行为。

  1. Yarn的高级用法:

    • 发布自己的包到Yarn Registry

要将自己的包发布到Yarn Registry,您需要按照以下详细步骤进行操作:

  1. 创建一个NPM账号:首先,确保您拥有一个NPM账号。如果没有,请访问NPM网站(https://www.npmjs.com/),按照指示注册一个新账号。

  2. 初始化项目:在项目根目录下使用终端打开。

  3. 初始化新项目:运行以下命令来初始化新的npm项目:

npm init

  1. 完成初始化:按照提示回答问题,包括包的名称、版本、描述等。确保在"entry point"和"test command"部分留空,如果没有特殊要求可以直接按回车。

  2. 编写代码:编写您的包的代码,并确保它在项目中正常运行。

  3. 创建README文件:在项目根目录中,创建一个名为README.md的文件,并添加包的详细说明和使用指南。

  4. 更新package.json:在package.json文件中,确保填写好"author"、"license"等字段,并根据需要添加其他依赖项。

  5. 确保登录npm账户:在终端中运行以下命令登录您的NPM账号:

npm login

按照提示输入您的NPM账号用户名、密码和邮箱。

  1. 发布包:运行以下命令将您的包发布到Yarn Registry:
npm publish

这将会将您的包发布到Yarn Registry,并使其可供其他人使用。

请注意,发布包之前,请确保您的包版本号是独一无二的,遵循语义化版本控制(Semantic Versioning)规范。

    • 使用Yarn Workspaces管理多个相关项目

使用Yarn Workspaces可以方便地管理多个相关的项目,并共享同一个包。下面是一些使用Yarn Workspaces的步骤:

  1. 首先,确保你的项目有一个顶层的 package.json 文件,并在其中添加一个 workspaces 字段,指定需要管理的工作区。例如:
{
  "name": "my-monorepo",
  "private": true,
  "workspaces": [
    "packages/*"
  ]
}

  1. 在顶层目录下创建一个 packages 文件夹,用来存放所有的工作区。

  2. packages 下创建相关的子目录,每个子目录代表一个工作区,每个工作区作为一个独立的项目。

  3. 在每个子目录中,创建一个 package.json 文件来定义该工作区的依赖关系和配置。例如:

{
  "name": "@my-monorepo/my-package",
  "version": "1.0.0",
  "dependencies": {
    "other-package": "^1.0.0"
  }
}

注意,为了确保依赖的相互正确性,你可以使用 scoped package 的命名规则,即 @my-monorepo

  1. 在项目根目录下运行 yarn install 安装所有的依赖。Yarn会自动使用符号链接将共享的包链接到每个工作区中。

通过这种方式,你可以轻松地共享包并在不同的项目中使用其他项目的依赖关系。Yarn会自动解析依赖关系,确保所有相关的包都正确安装和链接。你可以在单个工作区中运行脚本,也可以在整个项目中运行跨工作区的命令。

    • 设置Yarn的配置选项,如镜像源等

要设置Yarn的配置选项,你可以使用以下命令:

  1. 查看当前的配置选项:yarn config list
  2. 设置全局配置选项:yarn config set &lt;key> &lt;value>,例如:yarn config set registry https://registry.npm.taobao.org
  3. 设置项目级配置选项:在项目根目录下运行yarn config set &lt;key> &lt;value>,例如:yarn config set workspaces-experimental true
  4. 清除某个配置选项:yarn config delete &lt;key>

其中,一些常用的配置选项包括:

  • registry:指定包管理源
  • workspaces-experimental:启用实验性的工作区功能
  • no-progress:禁用进度条显示
  • strict-ssl:启用/禁用严格的SSL校验

希望这些信息能帮到你!

  1. Yarn的常见问题和故障排除:

    • 如何处理网络问题,如下载速度慢、连接超时等

如果您在使用Yarn时遇到网络问题,例如下载速度慢或连接超时,您可以尝试以下方法来解决问题:

  1. 更换镜像源:使用国内的镜像源可能会提高下载速度。您可以使用yarn config set registry &lt;registry-url>命令来更改Yarn的镜像源,例如使用淘宝镜像源 yarn config set registry https://registry.npm.taobao.org

  2. 使用代理:如果您的网络需要通过代理才能访问外部资源,您可以配置Yarn使用代理。可以使用yarn config set proxy &lt;proxy-url>yarn config set https-proxy &lt;proxy-url>命令来设置HTTP和HTTPS代理。

  3. 检查网络连接:确保您的网络连接正常,并且没有被防火墙或其他安全措施阻止Yarn的访问。

  4. 检查防火墙和杀毒软件设置:防火墙和杀毒软件有时会阻止Yarn的网络请求。您可以尝试禁用或配置防火墙和杀毒软件以允许Yarn的访问。

  5. 尝试使用VPN:如果您的网络使用了限制或限速,您可以尝试使用VPN来提供更稳定和快速的连接。

  6. 检查Yarn版本:确保您使用的是最新版本的Yarn,以获得最佳的网络性能和稳定性。您可以使用yarn self-update命令来更新Yarn。

  7. 重试操作:有时网络问题可能是暂时的,您可以尝试多次运行Yarn命令来重试操作。

如果尝试以上方法后仍然无法解决网络问题,您可能需要联系您的网络管理员或者与网络服务提供商进行进一步的协助。

希望这些方法对您有所帮助!

文章来源:https://blog.csdn.net/weixin_70007095/article/details/135760798
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。