yarn 是前端开发常用的 JavaScript 包管理工具,yarn 命令就是在终端执行的各类操作指令,主要用来安装依赖 更新依赖 删除依赖 查看包信息 执行脚本以及管理项目版本,相比 npm,yarn 命令的优势是安装速度更快,有 yarn.lock 锁定文件,团队成员安装出来的依赖版本一致性更好,支持离线缓存。很多新手刚开始接触前端项目,分不清 yarn 命令和 npm 命令的对应关系,也不知道初始化项目 安装全局包 清理缓存这些场景该输入哪一条 yarn 命令,本篇会把高频 yarn 命令分类整理,补充参数用法 常见报错处理,适合 Vue React 等前端项目日常开发使用。
yarn 命令基础认知
yarn 需要提前安装,电脑已经装好 Node.js 之后,可以通过 npm 安装 yarn 全局版本,安装完成打开终端,输入 yarn -v,如果可以输出版本号,就代表 yarn 命令已经可以正常调用。
yarn 所有 yarn 命令都需要在项目根目录执行,也就是存在 package.json 文件的文件夹,在错误目录执行 yarn 命令会提示找不到 package.json。
yarn.lock 文件是 yarn 命令自动生成的锁文件,作用是固定每一个依赖的精确版本,多人协作的时候提交这个文件,所有人安装的依赖版本保持统一,避免版本不一致引发项目报错。
高频 yarn 命令对照表
| 命令 | 功能说明 | 等价 npm 命令 |
|---|---|---|
| yarn init | 初始化新项目,生成 package.json | npm init |
| yarn install | 按照 package.json 和 yarn.lock 安装全部依赖 | npm install |
| yarn add 包名 | 安装单个依赖包,写入 dependencies | npm install 包名 |
| yarn add 包名 -D | 安装开发依赖,写入 devDependencies | npm install 包名 --save-dev |
| yarn add 包名 -g | 全局安装依赖包 | npm install 包名 -g |
| yarn remove 包名 | 卸载已经安装的依赖包 | npm uninstall 包名 |
| yarn upgrade 包名 | 升级指定依赖包版本 | npm update 包名 |
| yarn run 脚本名 | 执行 package.json 里面 scripts 定义的脚本 | npm run 脚本名 |
| yarn list | 列出当前项目全部已安装依赖 | npm list |
| yarn info 包名 | 查看远程仓库包的版本描述等信息 | npm info 包名 |
| yarn cache clean | 清理 yarn 本地缓存 | npm cache clean |
| yarn global list | 查看所有全局安装的包 | npm list -g |
核心 yarn 命令深度讲解
项目初始化与依赖安装
yarn init 执行之后终端会交互式询问项目名称 版本 描述 入口文件等信息,确认之后生成 package.json,也可以加上 yarn init -y,跳过所有提问,使用默认参数快速生成文件。
yarn install 是项目拉取代码之后第一步执行的 yarn 命令,它会读取 package.json 里面声明的依赖,结合 yarn.lock 锁定版本进行下载,如果没有 yarn.lock,就会根据 package.json 里面的版本范围解析最新匹配版本,同时自动生成锁文件。
yarn add 包名 是最常用的安装命令,安装完成之后会自动修改 package.json,同时更新 yarn.lock。如果需要指定版本,可以写成 yarn add 包名 @版本号,比如 yarn add axios@1.6.0。
依赖更新与卸载
yarn remove 包名执行之后,会把这个包从 node_modules 删除,同时从 package.json 依赖字段移除,同步更新 yarn.lock。
yarn upgrade 包名可以把依赖升级到符合 package.json 版本范围的最新版本,如果想要强制升级跨大版本,需要手动修改 package.json 版本号之后再执行 yarn install。
脚本执行命令
yarn run 脚本名,简写形式可以直接 yarn 脚本名,前提是 package.json 的 scripts 里面已经定义好对应的脚本,比如常见的 yarn dev 启动开发服务,yarn build 打包生产代码。这个 yarn 命令是前端项目开发每天都会用到,启动项目 打包 代码校验 单元测试都依靠它。
缓存相关 yarn 命令
yarn 会把下载过的包保存在本地缓存,再次安装相同包的时候直接读取缓存,提升安装速度。当缓存损坏,出现奇怪安装报错的时候,执行 yarn cache clean 清理缓存,之后重新 yarn install 一般可以解决异常。
使用 yarn 命令操作步骤
第一步 确认 Node 环境已经安装完成,终端执行 node -v 查看版本。
第二步 全局安装 yarn,执行 npm install -g yarn,安装完成 yarn -v 验证 yarn 命令可用。
第三步 进入项目根目录,执行 yarn install 安装项目全部依赖。
第四步 根据开发需求,使用 yarn add 新增依赖,yarn remove 卸载依赖,yarn run 执行启动或者打包脚本。
第五步 遇到安装异常,优先检查网络源,可以切换国内镜像源,再执行 yarn cache clean 清理缓存重试。
常见问题与排错
第一类报错是 yarn 命令找不到,代表 yarn 没有全局安装成功,或者系统环境变量没有配置,重新全局安装 yarn,检查环境变量。
第二类是安装超时,大多是官方源网络不稳定,切换淘宝镜像源之后重试 yarn 命令。
第三类是依赖版本冲突,yarn 会报 peer 依赖错误,需要核对依赖版本兼容关系,必要的时候修改 package.json 版本号。
第四类是 yarn.lock 和 package.json 版本不匹配,可以删除 node_modules 和 yarn.lock,重新执行 yarn install。
综合来看,yarn 命令体系和 npm 命令逻辑相似,但是安装机制和锁文件是核心特色,熟练掌握初始化 安装 卸载 升级 执行脚本 清理缓存这几类核心 yarn 命令,就可以满足绝大多数前端项目日常开发需求,团队协作场景下一定要保留 yarn.lock 文件,这也是使用 yarn 命令的重要规范。
【常见问题】
问题 1 yarn 命令和 npm 命令可以混用吗
回答 1 yarn 命令和 npm 命令不建议在同一个项目混用,yarn 命令生成 yarn.lock,npm 生成 package-lock.json,混用会造成锁文件冲突,依赖解析逻辑不一致,使用 yarn 命令的项目尽量全程都用 yarn 命令操作。
问题 2 yarn 命令执行 yarn dev 是什么作用
回答 2 yarn 命令里的 yarn dev,本质是执行 package.json scripts 中定义的 dev 脚本,属于 yarn run 的简写形式,绝大多数前端框架项目通过这条 yarn 命令启动本地开发调试服务。
问题 3 yarn 命令安装依赖很慢怎么处理
回答 3 使用 yarn 命令安装依赖速度慢,可以切换国内镜像源,也可以利用 yarn 本地缓存机制,缓存损坏的时候执行 yarn cache clean,再重新执行 yarn 命令安装依赖,改善 yarn 命令下载卡顿问题。
问题 4 yarn 命令 yarn add -D 是什么含义
回答 4 yarn 命令 yarn add -D 代表把包安装为开发依赖,写入 devDependencies 字段,这类包只在开发阶段使用,生产打包的时候不会打进最终产物,是 yarn 命令非常常用的安装参数。
【免责申明】
本文基于 yarn 官方公开文档整理,yarn 不同大版本部分 yarn 命令参数存在差异,操作前请核对本机 yarn 版本,本文仅作技术学习参考,项目生产环境操作请结合官方文档确认,因误执行 yarn 命令造成项目异常需要自行承担风险。


