本文主要是介绍rush 功能特性梳理,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
Rush 可以让 JavaScript 开发者更轻松地同时构建、发布多个 NPM 包,即将多个包或项目放到一个大仓库下管理。
仅需一次 NPM 安装
仅需一步,Rush 便可以将你项目的所有依赖安装到一个公共文件夹下,该文件夹并不像 “package.json” 一样位于项目的根目录(放到根目录的设计可能存在幻影依赖的问题),相反,Rush 使用符号链接来为每个项目重新构建一个准确的 “node_modules” 文件。
关于 “shrinkwrap 文件”
依据不同的包管理工具,shrinkwrap 文件可能是 shrinkwrap.yaml, npm-shrinkwrap.json, package-lock.json, 或 yarn.lock.(一些包管理工具使用了 “lock” 文件, 但该 “lock” 与文件的访问权限并无关系。在该文档中,由于我们并不知道你使用了哪种包管理工具,因此使用 “shrinkwrap” 来泛指这些文件。
通常,包管理工具会在每个项目文件夹内创建 shrinkwrap 文件,但是在 Rush 中,整个项目共用存储在 **common/config/rush" 目录下的一个 shrinkwrap 文件,它会被存储在 Git 内。 将所有依赖信息整合到单独一个 shrinkwrap 内有一些优势,例如减少冲突、方便查看 diff, 还能提高安装速度。
ensureConsistentVersions 依赖版本统一
我们推荐将 rush.json 内的 ensureConsistentVersions 设定为 true,它会使得 Rush 在执行操作包的指令时前执行 rush check。
该指令会去检查每个项目的 package.json 文件并保证所有的依赖都是同一个版本,该配置可以避免版本不一致导致的问题,因此推荐你打开。
npm分身
有时 node_modules 的数据结构会强制安装同一个包的两个相同版本的。这就相当于一个npm包有了分身。如B、C都依赖F1,E、F都依赖于F2,那么 node_modules 的数据结构有两种方式:要么安装两次F1(B、C node_modules下),一次F2(一级node_modules目录下),要么安装两次F2(E、F node_modules下),一次F1(一级node_modules目录下。
而 pnpm 解决了该问题。
幻影依赖
某个项目下引用了一个包,这个包不在其node_modules目录下,这种情况就是出现了幻影依赖。普通项目如果出现dependencies下的某个npm包依赖了其它包,则会自动在node_modules下被安装,这样项目中是可以直接引用这个其它包的,实际上在dependencies并没有这个其它包的声明,这样就出现了幻影依赖。而rush解决了这个问题。
而 rush 的符号链接解决了这个问题。
不建议在根目录安装npm包
在根目录放package.json且有依赖,执行npm i 后会产生node_modules目录,这样可能会造成幻影依赖。
指定rush的包管理器
基于幻影依赖和npm包分身,可以指定使用 pnpm 包管理器。
常用命令
# 安装所有项目依赖。会更新公共的 shrinkwrap 文件。
$ rush update# 与rush update 不同点是 rush install 不会更新任何文件,相反,如果存在过失的数据,则会在 PR 上报错,并提示你执行 rush update 或者提示你 commit 其结果。
$ rush install# 构建变动的项目。
$ rush build# 清空并构建所有项目。会默认查找每个项目的package.json的build命令并执行。
$ rush rebuild
rush update
当 package.json 文件发生变化时,请务必运行 rush update, 换句话说:
- 当从 git 上拉取新的更改(例如 git pull)后。
- 当项目内 package.json 文件被手动修改后。
- 当 common/config 目录下可能影响版本的文件(例如 pnpmfile.js, common-versions.json 等)被修改后。
rush update 内做了些什么:
- Rush 检查或应用各种可能会改变 common/config 内文件的策略。
- Rush 会将所有项目内的 package.json 文件与仓库的公共 shrinkwrap 文件进行比较来检查是否有效。
-
若无效,则包管理工具会更新 shrinkwrap 文件。
-
无论如何,包管理工具都会将所有依赖安装到 common/temp/node_modules 目录下。
- 最后,Rush 会给每个项目下构建一个 node_modules 文件夹,该文件夹下内容通过符合链接到 common/temp/node_modules. (该操作等同于 rush link)
这篇关于rush 功能特性梳理的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!