node.js - 实用程序的依赖项是否会进入 devDependencies 中？

Question

我正在用 NodeJS 编写一个库，供其他人使用。该库的测试依赖于测试框架，因此该框架列在devDependencies中。 package.json的部分这样任何将我的库拉入他们的代码的人都不会下载我的测试框架然后被忽略。

但是，我还有一个该库的命令行界面，如果有人选择全局安装该库，则应安装该界面，但当其他人将该库拉入自己的项目时，也应忽略该界面。这个 CLI 有一些依赖项，所以我试图找出在哪里列出它们，以便在全局安装时(或在库本身的开发工作期间)将它们拉入，但在另一个项目将库作为其依赖项拉入时忽略它们。

• 如果我在主 dependencies 中列出 CLI 依赖项部分，那么库的用户将把这些全部拉入他们自己的代码中，即使他们永远不会使用 CLI，所以这绝对是错误的地方。

• 如果我将它们列为 devDependencies那么它们将被排除在其他项目之外，这是理想的，但是如果有人尝试使用 --production 全局安装该库那么 CLI 依赖项将被忽略，并且 CLI 将无法工作，即使在这种情况下，“生产”安装肯定应该包含 CLI。

• bundledDependencies看起来不像我想要的，因为我不想在任何 bundle 中包含 CLI 依赖项，因为这些很可能是不使用 CLI 的情况。

• peerDependencies在这种情况下似乎不相关。

• optionalDependencies看起来并不理想，因为如果 CLI 依赖项由于某种原因失败，则全局安装将继续，但 CLI 将无法工作，这就是全局安装它的要点。

• 将 CLI 移至单独的包中也是一种选择，但是 CLI 在库开发过程中至关重要，因此将其作为单独包的一部分会使开发变得更加困难，因此我想避免这种情况。

看起来像devDependencies是唯一的选择，但是因为它有一些限制，我想在继续之前确认确实没有更好的选择!

Answer 1

我认为最好的方法是将 CLI 放在单独的包中，类似于 express-generator这是 Express 的 CLI。

即使这对开发至关重要，您的库用户也只需要输入一个额外的命令，npm install library-cli，如果正确记录了这一命令，我不会发现任何问题。

您还可以将 postinstall 脚本或自定义脚本添加到主库，以便在安装软件包后安装 CLI:

"scripts": {
    "postinstall": "npm install -g library-cli"
}

但是，如果您选择将 CLI 与主库捆绑在一起也没关系，但在这种情况下，您不应将 CLI 依赖项放入 devDependency 中。运行 cli 所需的所有模块都应进入依赖项，即使 90% 的用户永远不会使用它们。

devDependency 应该用于构建过程中所需的所有工具，例如缩小、测试、 typescript 等。CLI 运行时所需的所有内容都应该放入 dependency 中。