javascript - 从 Github 安装时自动构建 NPM 模块

Question

鉴于项目的 lib/ 目录不应 checkin Git，因为它包含的文件是派生文件(来自构建过程)。从项目的 github 安装包时(例如在开发期间)，lib/ 目录将不存在，因此如果包的 package.json 的 main 字段指向(例如)lib/index.js，导入时无法编译包，因为这些文件不存在于存储库中，因此也不存在于安装到 node_modules 中的包中。这意味着需要在本地构建包(就像发布之前一样)，以便将 lib 目录(或在构建过程中生成的任何其他文件)添加到模块的目录。

假设 package.json 文件的 scripts 字段中有一个 build 脚本，可以将包配置为运行此脚本仅从github安装的情况下会自动吗？如果没有，确保从 github 安装时构建它的最佳方法是什么？

现在有 prepublish、prepublishOnly 和 prepare 生命周期 Hook ，但没有一个提供此问题的答案，因为它们不允许任何区分安装来源的方法。简而言之，是的，它们允许您在安装上构建，但它们不允许您仅从 github 上构建安装。当人们从 npm 安装时，不仅没有理由强制构建，而且更重要的是，不会安装开发依赖项(例如对构建至关重要的 babel)。

我知道解决这个问题的一个策略:

• fork /分支存储库
• 本地构建
• 从 .gitignore 中删除 lib/ 目录并将其 checkin 。
• 从您的分支/分支安装模块
• 当您准备好 PR/rebase 时，将 lib/ 目录添加到 .gitignore 并从 git 中删除该目录。

但这远非理想。我想这可以通过 githook 自动化。因此，您每次插入掌握该项目时也会构建并推送到一个单独的分支。

有一个closed issue在 NPM 的 Github 上没有解决方案 - 只是很多人想要解决方案。从这个问题可以清楚地看出，使用 prepare 并不是答案。

我的用例是我正在开发一个在许多其他项目中使用的模块。我想使用模块的最新版本，而不必在每次更新代码库时向 NPM 推出版本 - 我宁愿在准备好时推出更少的版本，但我仍然需要使用库的最新版本在 Github 上。

注意:我还就这个问题联系了 NPM 的支持人员，如果收到他们的回复，我将添加他们的回复。

Answer 1

准备是正确的方法，但是可能看起来被破坏了

如果您有一个包含源文件的存储库，但需要“构建”步骤才能使用它，
prepare 在所有情况下都能完全满足您的需求(从 npm 4 开始)。

prepare: Run both BEFORE the package is packed and published, on local npm install without any arguments, and when installing git dependencies.

您甚至可以将构建依赖项放入 devDependency 中，它们将在执行 prepare 之前安装。

这里是an example我的一个包使用了这种方法。

<小时/>

.gitignore 的问题 - prepare 将看起来损坏

此选项有一个问题引起了很多人的关注。 准备依赖项时，Npm 和 Yarn 将仅保留 package.json 的 files 部分中列出的文件。

人们可能会看到 files defaults to all files being included并认为他们已经完成了。 很容易忽略的是:

• .npmignore 大部分会覆盖 files 指令和，
• 如果.npmignore不存在，则使用.gitignore。

因此，如果您像一个理智的人一样将构建的文件列在 .gitignore 中，并且不执行任何其他操作，prepare 将看起来坏了。

如果您将 files 修复为仅包含构建的文件或添加空的 .npmignore，则一切就绪。

我的建议是设置files(或者，通过反转，.npmignore)，以便仅实际发布的文件已发布软件包的用户所需的那些。恕我直言，无需在已发布的包中包含未编译的源代码。