@panache-cli/panache 3.1.0 → 3.2.0

package/bin/panache.js

@@ -1,7 +1,18 @@
 #!/usr/bin/env node
 "use strict";
 
-const { execFileSync } = require("node:child_process");
+const { execFileSync, spawnSync } = require("node:child_process");
+
+const PACKAGES = {
+  "linux-x64-gnu": "@panache-cli/linux-x64-gnu",
+  "linux-arm64-gnu": "@panache-cli/linux-arm64-gnu",
+  "linux-x64-musl": "@panache-cli/linux-x64-musl",
+  "linux-arm64-musl": "@panache-cli/linux-arm64-musl",
+  "darwin-x64": "@panache-cli/darwin-x64",
+  "darwin-arm64": "@panache-cli/darwin-arm64",
+  "win32-x64": "@panache-cli/win32-x64",
+  "win32-arm64": "@panache-cli/win32-arm64",
+};
 
 function detectLibc() {
   if (process.platform !== "linux") return null;
@@ -13,46 +24,83 @@ function detectLibc() {
   }
 }
 
-function platformPackage() {
+// Candidate platform keys in preference order. On linux the other libc
+// flavor is kept as a fallback: a host can report glibc yet be unable to
+// run generic glibc binaries (NixOS has no loader at the standard path),
+// while the musl build is statically linked and runs anywhere.
+function candidateKeys() {
   const { platform, arch } = process;
   const libc = detectLibc();
-
-  const map = {
-    "linux-x64-gnu": "@panache-cli/linux-x64-gnu",
-    "linux-arm64-gnu": "@panache-cli/linux-arm64-gnu",
-    "linux-x64-musl": "@panache-cli/linux-x64-musl",
-    "linux-arm64-musl": "@panache-cli/linux-arm64-musl",
-    "darwin-x64": "@panache-cli/darwin-x64",
-    "darwin-arm64": "@panache-cli/darwin-arm64",
-    "win32-x64": "@panache-cli/win32-x64",
-    "win32-arm64": "@panache-cli/win32-arm64",
-  };
-
-  const key = libc ? `${platform}-${arch}-${libc}` : `${platform}-${arch}`;
-  return { key, name: map[key] };
+  if (!libc) return [`${platform}-${arch}`];
+  const other = libc === "gnu" ? "musl" : "gnu";
+  return [`${platform}-${arch}-${libc}`, `${platform}-${arch}-${other}`];
 }
 
-function resolveBinary() {
-  const { key, name } = platformPackage();
-  if (!name) {
+function resolveCandidates() {
+  const keys = candidateKeys();
+  if (!PACKAGES[keys[0]]) {
     throw new Error(
-      `panache-cli does not ship a prebuilt binary for ${key}.\n` +
+      `panache-cli does not ship a prebuilt binary for ${keys[0]}.\n` +
         `Supported platforms: linux (x64/arm64, gnu+musl), darwin (x64/arm64), win32 (x64/arm64).\n` +
         `See https://panache.bz for alternative install methods.`,
     );
   }
   const binaryName = process.platform === "win32" ? "panache.exe" : "panache";
-  try {
-    return require.resolve(`${name}/${binaryName}`);
-  } catch (err) {
+  const candidates = [];
+  let firstError;
+  for (const key of keys) {
+    try {
+      candidates.push(require.resolve(`${PACKAGES[key]}/${binaryName}`));
+    } catch (err) {
+      firstError = firstError ?? err;
+    }
+  }
+  if (candidates.length === 0) {
     throw new Error(
-      `panache-cli expected the optional dependency ${name} to be installed, ` +
+      `panache-cli expected the optional dependency ${PACKAGES[keys[0]]} to be installed, ` +
         `but it could not be resolved.\n` +
         `This usually means npm skipped it (e.g. \`--no-optional\` or a registry/network issue ` +
         `during install). Try reinstalling with optional dependencies enabled.\n` +
-        `Original error: ${err.message}`,
+        `Original error: ${firstError.message}`,
     );
   }
+  return candidates;
+}
+
+function runnable(binary) {
+  const probe = spawnSync(binary, ["--version"], { stdio: "ignore" });
+  return probe.error == null && probe.status === 0;
+}
+
+// With a single candidate, trust it: probing every invocation would cost an
+// extra process spawn in the common case. Probing is reserved for the
+// unusual setup where both libc flavors are installed side by side.
+function pickBinary(candidates) {
+  if (candidates.length === 1) return candidates[0];
+  for (const binary of candidates) {
+    if (runnable(binary)) return binary;
+  }
+  return candidates[0];
+}
+
+function loaderHint() {
+  const libc = detectLibc();
+  if (libc !== "gnu") return;
+  const muslPackage = PACKAGES[`${process.platform}-${process.arch}-musl`];
+  process.stderr.write(
+    `The glibc build of panache cannot run on this system (no standard glibc loader; ` +
+      `on NixOS this is expected).\n` +
+      `The statically linked musl build works anywhere. Package managers skip it on ` +
+      `glibc hosts, so add it explicitly:\n` +
+      `  npm:  npm install --force ${muslPackage}\n` +
+      `  pnpm: pnpm config set supportedArchitectures.libc '["glibc","musl"]' && pnpm install\n` +
+      `Or install panache via other means (cargo install panache, nix, prebuilt binaries); ` +
+      `see https://panache.bz.\n`,
+  );
+}
+
+function resolveBinary() {
+  return pickBinary(resolveCandidates());
 }
 
 function main() {
@@ -68,12 +116,23 @@ function main() {
     execFileSync(binary, process.argv.slice(2), { stdio: "inherit" });
   } catch (err) {
     if (typeof err.status === "number") {
+      // 127 is the loader stub's exit code on hosts that cannot run the
+      // glibc build; probe to distinguish that from panache itself
+      // exiting 127 before hinting.
+      if (err.status === 127 && !runnable(binary)) {
+        loaderHint();
+      }
       process.exit(err.status);
     }
     if (err.signal) {
       process.kill(process.pid, err.signal);
       return;
     }
+    // The binary resolved but could not be spawned; a missing dynamic
+    // loader surfaces as ENOENT on hosts without NixOS's stub.
+    if (err.code === "ENOENT") {
+      loaderHint();
+    }
     process.stderr.write(`Failed to execute panache: ${err.message}\n`);
     process.exit(1);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@panache-cli/panache",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "An LSP, formatter, and linter for Pandoc markdown, Quarto, and RMarkdown",
   "keywords": [
     "quarto",
@@ -30,13 +30,13 @@
     "node": ">=20"
   },
   "optionalDependencies": {
-    "@panache-cli/linux-x64-gnu": "3.1.0",
-    "@panache-cli/linux-arm64-gnu": "3.1.0",
-    "@panache-cli/linux-x64-musl": "3.1.0",
-    "@panache-cli/linux-arm64-musl": "3.1.0",
-    "@panache-cli/darwin-x64": "3.1.0",
-    "@panache-cli/darwin-arm64": "3.1.0",
-    "@panache-cli/win32-x64": "3.1.0",
-    "@panache-cli/win32-arm64": "3.1.0"
+    "@panache-cli/linux-x64-gnu": "3.2.0",
+    "@panache-cli/linux-arm64-gnu": "3.2.0",
+    "@panache-cli/linux-x64-musl": "3.2.0",
+    "@panache-cli/linux-arm64-musl": "3.2.0",
+    "@panache-cli/darwin-x64": "3.2.0",
+    "@panache-cli/darwin-arm64": "3.2.0",
+    "@panache-cli/win32-x64": "3.2.0",
+    "@panache-cli/win32-arm64": "3.2.0"
   }
 }