创建具有依赖项的 NPM 包仅用于示例

Question

我现在正在开发一个 NPM 包。

包的主要代码 (repo/src/maincode.js) 有一些开发依赖项和运行它所需的一些依赖项。当用户安装 npm 包（通过 npm i）时，需要安装这些依赖项。

现在，话虽如此，我还想创建一个展示这个 npm 包的 react 项目，并将它放在同一个 repo 中的示例目录 (repo/examples/react/app.js) 中。这个 react 应用程序可能有自己的依赖项和开发依赖项，但我真的不希望在用户安装我的 npm 包时将所有这些都强加给用户，只是为了在他们的项目中使用。

我该如何解决这个问题？有没有办法创建一组仅在运行特定脚本或运行示例代码时安装的依赖项？

Answer 1

您可以为examples 目录提供其自己的package.json 文件，并指示想要运行cd 示例的人进入examples 目录并在那里运行npm i。 examples 目录中导入模块的任何代码都将在检查父目录中的 node_modules 之前先查看其自己的 node_modules。

MarkoJS examples repository 采用了这种方法，甚至使其更加细化。 examples 目录没有一个 package.json，每个单独的示例都有一个 package.json。

如果需要，您可以在主package.json 中为用户so they can do something like npm run build-examples and it will do the npm install for them 创建一个帮助脚本，作为该过程的一部分。