如何在源更改时重建 node.js 插件

How to rebuild node.js addon when source changes

我有一个 node.js 应用程序并且我创建了一个本地插件。 (如果您需要背景信息,可以创建 node.js 的原生插件 like this)。

在我的开发环境中,我希望它监视源文件(在本例中是 C++ 源文件)并在 C++ 源文件更改时自动重建我的插件,并在构建完成后自动重新启动节点应用程序.

我敢肯定有不止一种方法可以做到这一点,但我还是尝试了 nodemon。但是我不知道如何让 nodemon 在重新启动应用程序之前等待构建完成。

我认为 npm 本身也可以使用脚本来完成此操作,也许使用某种 watch 包。所以如果有更简单的方法,我愿意接受其他方法。

因此,当我的任何源文件发生更改时,我真正需要的只是在重新启动工作流(停止节点、重新编译、重新启动节点)的正确位置将 node-gyp build 更改为 运行。现在它重建插件并重新启动应用程序 而无需等待构建完成 ,这是不可取的。

这是我的 nodemon.json 文件:

{
  "watch": [
    "addon/"
  ],
  "ignore": [
    "addon/build/"
  ],
  "events": {
    "restart": "cd addon && node-gyp build"
  },
  "ext": "js,json,cc,h"
}

这不起作用,因为 "restart" 就像一个事件,因为我的脚本 运行s node-gyp 触发并执行,但它不会阻止重新启动,直到构建完成了。

我希望它的工作方式更像中间件,它会在应用程序终止后但在重新启动应用程序之前 运行 生成脚本。我也咨询了 this relevant nodemon issue,但没有关于如何实现这一点的具体建议。

我需要更改一些内容,以便在源更改时自动进行重建(node-gyp 步骤),然后很好地重新启动。

注意:稍后我将对其进行重组,使其仅在相关C++源文件更改时重建插件,而在.js文件更改时仅重新启动应用程序而不重建C++插件,但是首先,我需要弄清楚让 node-gyp 构建步骤在正确的时间发生。

我通过让 nodemon 使用 运行 npm-x 选项解决了这个问题。然后npm脚本可以依次执行build运行脚本

这是我的 package.json 的相关部分:

"scripts": {
  "dev": "nodemon -x \"npm run buildrun\"",
  "buildrun": "npm run build && npm run server",
  "build": "echo Building Addon && cd addon && node-gyp build",
  "server": "nodemon server.js",
}

你通过 运行ning npm run dev 来启动这个。

dev 运行s nodemon with the -x option and the command is npm run buildrun.然后每次代码更改时,nodemon 都会重新启动 npm buildrun 脚本。这是我难以理解的主要部分。

为了解释其余部分,buildrun 脚本 运行 两个背靠背的脚本。第一个 (build) 构建插件,第二个 (server) 运行 构建服务器。

服务器脚本实际上 运行 也是 nodemon:它 运行 是 运行 服务器脚本的另一个 nodemon nodemon server.js

Technically, by having npm calling nodemon again (with the right configuration files, different arguments and context) nodemon could watch a different piece of the codebase and restart a different part of the system (e.g., watch just the server code without rebuilding the whole addon, which is what my actual code does.)

通过使用 -x 选项调用 nodemon 并在代码更改时重新启动整个构建和 运行 脚本,我能够对操作进行排序以使 nodemon 首先构建插件,等待构建完成,然后运行服务器。

这个 nodemon -x \"npm ...\" 技术起初对我来说并不明显,实际上我花了半年时间才想出这个解决方案。所以,我分享这个是因为其他人可能会发现这种技术很有用。