在每个基于 Node.js 的 Web 应用程序我的项目中,咱们都有一个名为 package.json 的文件。该文件蕴含无关我的项目的所有相干数据,即元数据。package.json 中可能定义 dependency,devDependency 和 Peer Dependency 三种不同的依赖类型。
本文概括 Peer Dependency 的一些常见的应用场景。
- Babel plugins:在 Babel 插件的开发里,须要将 Babel 本身定义成 peer dependency.
- Express middleware packages:这是一个典型的须要应用对等依赖项的 NPM 模块开发场景。中间件包的开发者心愿将 express 申明为依赖项,而不是一个
硬
依赖项。否则,每个中间件 package 的每次装置,都会将整个 express 装置到 node_modules 文件夹下。 - 如果正在构建微前端,须要确定哪些依赖项是内部的(因而它们不会被 bundled)而哪些不是。对等依赖关系可能是解决此问题的一个可选计划。
整个框架。 - Bit Components:如果正在编写和公布前端组件,例如在 Bit 上共享 React 组件时。在这种状况下,能够将 React 申明为组件的对等依赖项,其语义是,开发人员心愿宿主我的项目具备 peer Dependency 指定的正确版本。
看个理论的例子,一个可能反复点击的按钮:
装置结束后,察看其 package.json 里定义的 peer Dependency:
在这个 package.json 文件里,这个包没有定义任何的间接依赖关系,即便它是在 React 之上工作的。咱们确保诸如 React 和 React-dom 之类的货色是必须的(required),只是没有装置(not installed)。这就是 NPM 的对等依赖关系所想表白的语义。
鉴于基于 plugin 的架构的灵活性,许多库都在利用它,容许开发人员依据他们的须要,有机地扩大框架的性能。这使得任何有趣味为这些框架开发新性能的开发人员,都有必要把握 Peer Dependency 的正确用法。