node.js - 实用程序的依赖项是否进入 devDependencies?
问题描述
我正在用 NodeJS 编写一个库,供其他人使用。该库具有依赖于测试框架的测试,因此该框架列在devDependencies
部分中,package.json
这样任何将我的库拉入他们的代码的人都不会下载我的测试框架然后被忽略。
但是,我还有一个库的命令行界面,如果有人选择全局安装库,则应该安装它,但当其他人将库拉入他们自己的项目时,也应该忽略它。这个 CLI 有一些依赖项,所以我试图找出在哪里列出它们,以便在全局安装时(或在库本身的开发工作期间)将它们拉入,但在另一个项目将库作为其依赖项拉入时被忽略。
如果我在主要部分列出 CLI 依赖
dependencies
项,那么库的用户将把这些都拉到他们自己的代码中,即使他们永远不会使用 CLI,所以这绝对是错误的地方。如果我将它们列出,
devDependencies
那么它们将被排除在理想的其他项目之外,但是如果有人尝试使用全局安装库,--production
那么 CLI 依赖项将被忽略并且 CLI 将无法工作,即使在这种情况下是 '生产安装绝对应该包括 CLI。bundledDependencies
看起来不像我想要的,因为我不想在任何包中包含 CLI 依赖项,因为这些很可能是不使用 CLI 的情况。peerDependencies
在这种情况下似乎不相关。optionalDependencies
似乎并不理想,因为如果 CLI 依赖项由于某种原因失败,则全局安装将继续,但 CLI 将无法工作,这就是全局安装它的意义所在。将 CLI 移到单独的包中也是一种选择,但是 CLI 在库开发过程中至关重要,因此将其作为单独包的一部分会使开发更加困难,因此我想避免这种情况。
它看起来devDependencies
是唯一的选择,但是因为它有一些限制,我想确认在继续之前确实没有更好的选择!
解决方案
我认为最好的方法是将 CLI 放在一个单独的包中,类似于express-generator,它是 express 的 CLI。
即使它对开发至关重要,您的库用户也只需要输入一个额外的命令,npm install library-cli
如果这被正确记录,我看不到任何问题。
您还可以在postinstall
安装包后将脚本或自定义脚本添加到安装 CLI 的主库中:
"scripts": {
"postinstall": "npm install -g library-cli"
}
但是,如果您选择将 CLI 与主库捆绑在一起也很好,但是在这种情况下,您不应该将 CLI 依赖项放入devDependencies
. 运行 cli 所需的所有模块都应该进入,dependencies
即使 90% 的用户永远不会使用它们。
devDependencies
应该用于构建过程中所需的所有工具,例如缩小、测试、打字稿等。CLI 运行时所需的所有内容都应该放入dependencies
.
推荐阅读
- reactjs - Redux 文档中关于 createSelector 和 createEntityAdapter 的问题
- php - 用户登录,角色在 PHP 中无法正常工作
- python - 用 Flask @auth.login_required 装饰器装饰的端点的单元测试
- android - 活动!!将 android studio 更新到 4.1 时显示红色下划线
- verilog - 如何在 verliog 中进行更准确的计算 ln(1+x)
- javascript - 在列表项中添加条件
- java - 从外部类调用时 Java Swing 标签不更新
- r - R - 如何从 emp 和 supervisor 的 2 列添加报告级别
- javascript - jquery-ajax 将html元素值从一个页面传递到另一个页面
- javascript - 为什么 v2 未定义但具有数组中最后一个元素的值?