Yarn的安装与配置指南
Yarn 是一个快速、可靠和安全的依赖管理工具,它能取代 npm 来管理 JavaScript 项目的依赖关系。以下是详细的 Yarn 安装与配置指南。
1. 安装 Yarn
Yarn 可以通过多种方式安装,具体步骤如下:
1.1 通过 npm 安装
如果已经安装了 Node.js 和 npm,可以使用 npm 安装 Yarn:
npm install -g yarn
安装完成后,可以通过以下命令验证 Yarn 是否安装成功:
yarn --version
1.2 通过 Homebrew 安装(适用于 macOS)
在 macOS 上,Yarn 可以通过 Homebrew 安装。首先,确保已经安装 Homebrew,然后执行以下命令:
brew install yarn
同样地,安装完成后,通过以下命令验证安装是否成功:
yarn --version
1.3 通过安装包安装
Yarn 官方网站提供了安装包,用户可以根据自己的操作系统下载相应的安装包进行安装。
-
访问 Yarn 官方网站:https://classic.yarnpkg.com/en/docs/install
-
根据操作系统选择安装包,并按照提示进行安装。
2. 配置 Yarn
Yarn 的配置文件为 .yarnrc
文件。可以在项目根目录或用户主目录下创建此文件进行全局配置。常见的配置项如下:
2.1 设置全局缓存目录
Yarn 默认会将缓存文件存储在用户目录下的 .cache/yarn
中,可以通过以下配置更改缓存目录:
yarn config set cache-folder <path-to-cache-folder>
2.2 设置全局安装目录
可以指定全局安装包的存放目录:
yarn config set global-folder <path-to-global-folder>
2.3 设置代理
如果需要通过代理访问网络,可以设置代理:
yarn config set proxy <http://proxyaddress:port> yarn config set https-proxy <http://proxyaddress:port>
2.4 配置私有 npm 仓库
如果项目使用私有 npm 仓库,可以通过以下命令配置:
bash 复制代码 yarn config set registry <https://registry.your-company.com>
2.5 配置镜像源(适用于中国用户)
为了提高下载速度,中国用户可以配置镜像源:
yarn config set registry https://registry.npmmirror.com
3. 使用 Yarn
3.1 初始化项目
在一个新项目中使用 Yarn 初始化项目:
bash 复制代码 yarn init
这将引导你通过一系列提示生成一个 package.json
文件。
3.2 安装依赖
在项目根目录下运行以下命令安装依赖:
yarn install
3.3 添加依赖
要添加新依赖,可以使用以下命令:
yarn add <package-name>
要添加开发依赖,可以使用 -D
或 --dev
选项:
yarn add <package-name> -D
3.4 删除依赖
要删除依赖,可以使用以下命令:
yarn remove <package-name>
3.5 更新依赖
要更新项目中的依赖,可以使用以下命令:
yarn upgrade
可以指定特定包进行升级:
yarn upgrade <package-name>
4. 常见问题排查
4.1 清理缓存
如果遇到依赖问题,可以尝试清理缓存:
yarn cache clean
4.2 强制重新安装所有依赖
有时候需要强制重新安装所有依赖,可以删除 node_modules
目录和 yarn.lock
文件,然后重新安装:
rm -rf node_modules yarn.lock yarn install
5. 高级配置
5.1 使用 .yarnrc.yml
进行高级配置
Yarn 2.x 及以上版本使用 .yarnrc.yml
进行配置,例如设置插件、工作空间等。
5.2 使用 Yarn Plug'n'Play
Yarn 提供了 Plug'n'Play(PnP)特性,用于提高性能并简化依赖管理。启用 PnP:
yarn set version berry yarn config set nodeLinker pnp
6. Yarn 命令参考
-
yarn init
:初始化一个新的项目 -
yarn install
:安装项目的所有依赖 -
yarn add <package-name>
:添加一个依赖 -
yarn remove <package-name>
:删除一个依赖 -
yarn upgrade
:更新项目中的依赖 -
yarn cache clean
:清理缓存 -
yarn config set <key> <value>
:设置配置项 -
yarn config get <key>
:获取配置项 -
yarn global add <package-name>
:全局安装一个依赖 -
yarn global remove <package-name>
:全局删除一个依赖