yarn 安装与配置技术文档
yarn 是一个由 Facebook 开发的 JavaScript 包管理器,旨在提供更快、更可靠和更安全的依赖管理解决方案。它与 npm 类似,但通过并行安装、确定性依赖解析和离线模式等功能,显著提高了安装速度和一致性。Yarn 还支持工作区管理,方便处理 monorepo 项目。
1. yarn的安装
(前排提示,此文档仅供简要参考,更多详细操作步骤可以查看文档末的官方链接)
Yarn 可以通过多种方式安装,以下是几种常见的方法:
1.1 使用 npm 安装 Yarn
如果你已经安装了 Node.js 和 npm,可以通过以下命令全局安装 Yarn:
npm install -g yarn
1.2 使用安装脚本
你可以使用 Yarn 官方提供的安装脚本进行安装:
curl -o- -L https://yarnpkg.com/install.sh | bash
1.3 通过 Homebrew 安装 (macOS)
如果你在 macOS 上,可以使用 Homebrew 安装 Yarn:
brew install yarn
1.4 通过 Chocolatey 安装 (Windows)
如果你在 Windows 上,可以使用 Chocolatey 安装 Yarn:
choco install yarn
1.5 通过安装包管理器 (Linux)
在不同的 Linux 发行版上,可以使用各自的包管理器安装 Yarn。例如,在 Ubuntu 上:
sudo apt update && sudo apt install yarn
2. 配置 Yarn
Yarn 的配置文件是 .yarnrc
或 .yarnrc.yml
,你可以在项目根目录或用户主目录下创建该文件来进行全局或本地配置。
2.1 配置镜像源
可以使用以下命令设置国内镜像源,以加快包的下载速度:
yarn config set registry https://registry.npm.taobao.org
2.2 配置缓存目录
你可以指定缓存目录来存储下载的包:
yarn config set cache-folder /path/to/cache
2.3 查看配置
你可以使用以下命令查看当前的 Yarn 配置:
yarn config list
3. 初始化项目
使用 Yarn 初始化一个新项目:
yarn init
该命令会引导你完成项目的初始化过程,生成 package.json
文件。
4. 常用命令
4.1 安装依赖
安装指定的依赖包:
yarn add [package-name]
安装特定版本的依赖包:
yarn add [package-name]@[version]
安装开发依赖:
yarn add [package-name] --dev
4.2 移除依赖
移除指定的依赖包:
yarn remove [package-name]
4.3 更新依赖
更新指定的依赖包:
yarn upgrade [package-name]
4.4 安装项目所有依赖
安装 package.json
中列出的所有依赖:
yarn install
4.5 检查依赖
检查项目中的依赖包是否有问题:
yarn check
4.6 清理缓存
清理 Yarn 缓存:
yarn cache clean
4.7 运行脚本
在 package.json
中定义的脚本可以通过以下命令运行:
yarn run [script-name]
5. 示例项目结构
一个使用 Yarn 管理依赖的典型项目结构如下:
my-project/
├── node_modules/
├── package.json
├── yarn.lock
└── src/
└── index.js
node_modules/
:存放项目的依赖包。package.json
:项目的配置文件,记录了项目的依赖包信息。yarn.lock
:锁定文件,确保在不同的环境中安装的依赖包版本一致。src/
:项目的源代码目录。
6. 进阶配置
6.1 使用 .yarnrc.yml
配置文件
你可以将配置写入 .yarnrc.yml
文件。例如:
nodeLinker: "node-modules"
yarnPath: "./.yarn/releases/yarn-berry.cjs"
6.2 工作区 (Workspaces)
Yarn 支持 monorepo 项目结构,可以通过工作区配置来管理多个子项目。创建一个顶级项目,并在 package.json
中配置工作区:
{
"private": true,
"workspaces": [
"packages/*"
]
}
然后在 packages
目录下创建多个子项目,每个子项目都包含自己的 package.json
文件。
7. 参考资料
通过以上步骤,能够成功安装并配置 Yarn,并开始使用它来管理你的 JavaScript 项目依赖。如果你有任何问题,可以查阅 Yarn 官方文档或社区资源。
标签:依赖,package,配置,Yarn,用法,yarn,安装 From: https://blog.csdn.net/m0_67414667/article/details/140259109