diff options
| -rw-r--r-- | build.rs | 25 |
1 files changed, 18 insertions, 7 deletions
@@ -4,19 +4,30 @@ fn main() -> Result<(), io::Error> { // trigger recompilation when a new migration is added println!("cargo::rerun-if-changed=migrations"); - // rerun npm install whenever packages or npm config are changed + // The following sections are intended to allow developers and packagers to create a working + // `pilcrow` binary in one step in a clean source tree, using Cargo, even though Pilcrow is + // written in two-and-a-half languages. + // + // The final binary embeds the Svelte UI. These steps build it. And, in service of that one-step + // build idea, they also install the NPM dependencies needed to carry out that build. (Cargo + // does this out of the box for Rust dependencies.) + + // rerun npm ci whenever packages or npm config are changed println!("cargo::rerun-if-changed=.npmrc"); println!("cargo::rerun-if-changed=package.json"); - // `node_modules` and `package-lock.json` are always touched if `npm install` - // runs, leading to spurious rebuilds. + println!("cargo::rerun-if-changed=package-lock.json"); + // In theory, we should rerun `npm ci` if `node_modules` has changed since the last build, to + // put it back into a known-good state. However, `npm ci` itself _always_ rewrites + // `node_modules`, so asking Cargo to rerun this build script if `node_modules` changes leads to + // Cargo always rerunning this build script. So, as a compromise, we assume that changes to + // `package-lock.json` or `package.json` are sufficient justification to rerun `npm ci`, because + // those are the most likely secondary indicators of changes to the installed packages. // - // See: <https://github.com/npm/cli/issues/7874> - // println!("cargo::rerun-if-changed=package-lock.json"); // println!("cargo::rerun-if-changed=node_modules"); - let status = Command::new("npm").args(["install"]).status()?; + let status = Command::new("npm").args(["ci"]).status()?; if !status.success() { return Err(io::Error::other(format!( - "'npm install' exited with status {status:?}" + "'npm ci' exited with status {status:?}" ))); } |