devlanes 0.2.0 → 0.4.0

package/README.md

@@ -40,7 +40,9 @@ yaml-language-server resolves the path from the YAML file's directory, so it fit
 
 ## Behaviour
 
-This package holds a small launcher. npm installs the native binary from one of the `@devlanes/<platform>-<arch>` packages, picked by `os`, `cpu` and `libc`. Builds exist for macOS arm64 and x64 and for Linux arm64 and x64 with glibc.
+npm installs the native binary from one of the `@devlanes/<platform>-<arch>` packages, picked by `os`, `cpu` and `libc`. Builds exist for macOS arm64 and x64 and for Linux arm64 and x64 with glibc.
+
+The postinstall script replaces this package's `bin/devlanes` with that binary, so `devlanes` runs without starting Node. When the script does not run (`--ignore-scripts`, Yarn) or fails, `bin/devlanes` stays a small Node launcher that starts the binary, and everything works the same. npm 12, pnpm and Bun skip install scripts of dependencies unless allowed: `npm install -g --allow-scripts=devlanes devlanes`, `pnpm approve-builds` or `bun pm trust devlanes`.
 
 ## License
 

package/bin/devlanes

@@ -0,0 +1,57 @@
+#!/usr/bin/env node
+"use strict";
+
+// Runs the native binary from the @devlanes/<platform>-<arch> package that npm
+// installed as an optional dependency. install.js replaces this file with that
+// binary, so it only runs when the postinstall script did not (--ignore-scripts,
+// Yarn, Windows) or could not swap it.
+const { spawn } = require("node:child_process");
+const path = require("node:path");
+
+const windows = process.platform === "win32";
+const platform = `${process.platform}-${process.arch}`;
+let binary;
+try {
+  const manifest = require.resolve(`@devlanes/${platform}/package.json`);
+  binary = path.join(path.dirname(manifest), "bin", windows ? "devlanes.exe" : "devlanes");
+} catch {
+  console.error(
+    `devlanes: no binary installed for ${platform}. Release builds exist for ` +
+      "darwin-arm64, darwin-x64, linux-arm64 and linux-x64 (glibc), win32-arm64 and win32-x64.\n" +
+      "If npm ran with --omit=optional or --no-optional, reinstall without it.",
+  );
+  process.exit(1);
+}
+
+const child = spawn(binary, process.argv.slice(2), { stdio: "inherit" });
+
+if (windows) {
+  // Ctrl-C, Ctrl-Break and closing the console reach every process attached to
+  // the console, the binary included, which handles them itself. The listeners
+  // only keep Node from exiting before it; child.kill() would end the binary
+  // without notice.
+  for (const signal of ["SIGINT", "SIGBREAK", "SIGHUP"]) process.on(signal, () => {});
+} else {
+  // The terminal already delivers SIGINT and SIGQUIT to the whole process group,
+  // so forwarding them would reach the binary twice. Signals sent only to this
+  // wrapper are passed on.
+  for (const signal of ["SIGINT", "SIGQUIT"]) process.on(signal, () => {});
+  for (const signal of ["SIGTERM", "SIGHUP"]) {
+    process.on(signal, () => child.kill(signal));
+  }
+}
+
+child.on("error", (error) => {
+  console.error(`devlanes: cannot run ${binary}: ${error.message}`);
+  process.exit(1);
+});
+child.on("exit", (code, signal) => {
+  // Windows processes end with a code only, such as 0xC000013A after Ctrl-C,
+  // which process.exit passes on unchanged.
+  if (signal && !windows) {
+    process.removeAllListeners(signal);
+    process.kill(process.pid, signal);
+    return;
+  }
+  process.exit(code ?? 1);
+});

package/install.js

@@ -0,0 +1,75 @@
+"use strict";
+
+// Postinstall: replaces the Node launcher at bin/devlanes with the native binary
+// from @devlanes/<platform>-<arch>, so the package manager's bin link runs it
+// without starting Node. Any failure leaves the launcher in place and never fails
+// the install.
+const { execFileSync } = require("node:child_process");
+const fs = require("node:fs");
+const path = require("node:path");
+
+const { version } = require("./package.json");
+const binDir = path.join(__dirname, "bin");
+
+// Yarn PnP keeps packages in zip archives. Yarn may also rerun install scripts in
+// a node_modules shared between platforms (for example a mounted Docker volume),
+// and a swapped binary would then be the wrong one, so Yarn keeps the launcher.
+function skipped() {
+  return (
+    process.platform === "win32" ||
+    Boolean(process.versions.pnp) ||
+    /\byarn\//.test(process.env.npm_config_user_agent || "")
+  );
+}
+
+/** Fails unless `file args` prints `<name> <version>` as its first two words. */
+function checkVersion(file, args, name) {
+  const output = execFileSync(file, args, { stdio: "pipe", timeout: 30_000 }).toString();
+  const [reportedName, reportedVersion] = output.trim().split(/\s+/);
+  if (reportedName !== name || reportedVersion !== version) {
+    throw new Error(`${name} reported ${JSON.stringify(output.trim())}, expected ${version}`);
+  }
+}
+
+/**
+ * Puts `source` at bin/<name>: a hard link (else a copy) to a temporary name in
+ * the same directory, checked by running it, then renamed over the target. The
+ * rename never writes into an existing file, which pnpm may share with its store.
+ */
+function place(source, name, args) {
+  const target = path.join(binDir, name);
+  const temp = path.join(binDir, `.${name}.${process.pid}.tmp`);
+  fs.rmSync(temp, { force: true });
+  try {
+    try {
+      fs.linkSync(source, temp);
+    } catch {
+      fs.copyFileSync(source, temp);
+      fs.chmodSync(temp, 0o755);
+    }
+    checkVersion(temp, args, name);
+    fs.renameSync(temp, target);
+  } finally {
+    // A rerun links the file that is already the target; rename then succeeds
+    // without removing the temporary name.
+    fs.rmSync(temp, { force: true });
+  }
+}
+
+function main() {
+  if (skipped()) return;
+  const platform = `${process.platform}-${process.arch}`;
+  const manifest = require.resolve(`@devlanes/${platform}/package.json`);
+  const sourceDir = path.join(path.dirname(manifest), "bin");
+  // `devlanes certs trust --hosts` looks for devlanes-hosts next to the resolved
+  // devlanes executable, so the helper moves first and the binary only with it.
+  place(path.join(sourceDir, "devlanes-hosts"), "devlanes-hosts", ["version"]);
+  place(path.join(sourceDir, "devlanes"), "devlanes", ["--version"]);
+}
+
+try {
+  main();
+} catch (error) {
+  const reason = String(error && error.message ? error.message : error).split("\n")[0];
+  console.error(`devlanes: keeping the Node launcher: ${reason}`);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "devlanes",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Development environments in Git worktree lanes",
   "license": "Apache-2.0",
   "homepage": "https://devlanes.run",
@@ -10,10 +10,14 @@
     "directory": "packaging/npm/devlanes"
   },
   "bin": {
-    "devlanes": "bin/devlanes.js"
+    "devlanes": "bin/devlanes"
+  },
+  "scripts": {
+    "postinstall": "node install.js"
   },
   "files": [
     "bin",
+    "install.js",
     "schema.json",
     "user-schema.json"
   ],
@@ -26,9 +30,11 @@
     "node": ">=18"
   },
   "optionalDependencies": {
-    "@devlanes/darwin-arm64": "0.2.0",
-    "@devlanes/darwin-x64": "0.2.0",
-    "@devlanes/linux-arm64": "0.2.0",
-    "@devlanes/linux-x64": "0.2.0"
+    "@devlanes/darwin-arm64": "0.4.0",
+    "@devlanes/darwin-x64": "0.4.0",
+    "@devlanes/linux-arm64": "0.4.0",
+    "@devlanes/linux-x64": "0.4.0",
+    "@devlanes/win32-arm64": "0.4.0",
+    "@devlanes/win32-x64": "0.4.0"
   }
 }