@jaccard-ai/cli 0.6.0-linux-arm64 → 0.6.0

package/bin/jaccard.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+// @ts-check
+// Runs the native jaccard binary from the platform build that npm installed
+// through optionalDependencies. CommonJS with no dependencies: it must start
+// on every Node the `engines` field admits.
+'use strict';
+
+const { spawn } = require('node:child_process');
+const os = require('node:os');
+const path = require('node:path');
+
+const { binaryPackage } = require('../lib/platform.js');
+// Only the staged manifest lists the platform builds; the workspace one has none.
+/** @type {{ version: string, optionalDependencies?: Record<string, string> }} */
+const manifest = require('../package.json');
+const optionalDependencies = manifest.optionalDependencies || {};
+
+/**
+ * @param {string} message
+ * @returns {never}
+ */
+function fail(message) {
+  process.stderr.write(`jaccard: ${message}\n`);
+  process.exit(1);
+}
+
+/** @returns {string} */
+function resolveBinary() {
+  let alias;
+  try {
+    alias = binaryPackage(process.platform, process.arch, optionalDependencies);
+  } catch (err) {
+    return fail(err instanceof Error ? err.message : String(err));
+  }
+  try {
+    return path.join(path.dirname(require.resolve(`${alias}/package.json`)), 'bin', 'jaccard');
+  } catch {
+    return fail(
+      `${alias} is not installed. npm leaves it out under --omit=optional, and so can a ` +
+        'lockfile written on another OS or CPU. Reinstall with optional dependencies: ' +
+        'npm install -g @jaccard-ai/cli',
+    );
+  }
+}
+
+const binary = resolveBinary();
+
+// Without forwarding, `kill` on this process (as timeout(1) and process
+// supervisors do) would exit Node and leave the binary running. The handlers
+// must be in place before spawn: until then a signal still kills Node outright.
+/** @type {NodeJS.Signals[]} */
+const SIGNALS = ['SIGINT', 'SIGTERM', 'SIGHUP'];
+/** @type {import('node:child_process').ChildProcess | undefined} */
+let child;
+/** @param {NodeJS.Signals} signal */
+const forward = (signal) => {
+  if (child && child.exitCode === null && child.signalCode === null) child.kill(signal);
+};
+for (const signal of SIGNALS) process.on(signal, forward);
+
+child = spawn(binary, process.argv.slice(2), { stdio: 'inherit' });
+child.on('error', (err) => fail(`could not run ${binary}: ${err.message}`));
+
+child.on('exit', (code, signal) => {
+  if (signal === null) {
+    process.exit(code === null ? 1 : code);
+  }
+  // Dying by the same signal, not exiting 128+n, is what stops a shell loop on Ctrl-C.
+  for (const s of SIGNALS) process.removeListener(s, forward);
+  process.kill(process.pid, signal);
+  // Reached only for a signal Node ignores, such as SIGPIPE.
+  process.exitCode = 128 + (os.constants.signals[signal] || 0);
+});

package/lib/platform.js

@@ -0,0 +1,38 @@
+// @ts-check
+'use strict';
+
+// Each platform build is an optionalDependencies alias named PREFIX + `<os>-<cpu>`,
+// with `os`/`cpu` from Node's process.platform and process.arch.
+const PREFIX = '@jaccard-ai/cli-';
+
+/**
+ * Names the alias that carries the binary for this machine.
+ *
+ * @param {string} platform process.platform
+ * @param {string} arch process.arch
+ * @param {Record<string, string>} optionalDependencies this package's manifest field
+ * @returns {string}
+ * @throws {Error} when no published build fits this machine
+ */
+function binaryPackage(platform, arch, optionalDependencies) {
+  if (platform === 'win32') {
+    throw new Error(
+      'Windows is not supported yet. Run jaccard inside WSL: ' +
+        'https://learn.microsoft.com/windows/wsl/install',
+    );
+  }
+  const alias = `${PREFIX}${platform}-${arch}`;
+  if (!Object.prototype.hasOwnProperty.call(optionalDependencies, alias)) {
+    const supported = Object.keys(optionalDependencies)
+      .filter((name) => name.startsWith(PREFIX))
+      .map((name) => name.slice(PREFIX.length))
+      .sort();
+    throw new Error(
+      `there is no jaccard build for ${platform}-${arch}. ` +
+        `Supported: ${supported.join(', ') || 'none'}.`,
+    );
+  }
+  return alias;
+}
+
+module.exports = { binaryPackage };

package/package.json

@@ -1,19 +1,26 @@
 {
   "name": "@jaccard-ai/cli",
-  "version": "0.6.0-linux-arm64",
-  "description": "The linux-arm64 build of @jaccard-ai/cli. Install @jaccard-ai/cli instead.",
+  "version": "0.6.0",
+  "description": "The Jaccard platform CLI.",
   "license": "SEE LICENSE IN README.md",
-  "os": [
-    "linux"
-  ],
-  "cpu": [
-    "arm64"
-  ],
+  "homepage": "https://www.jaccard.ai",
+  "bin": {
+    "jaccard": "bin/jaccard.js"
+  },
   "files": [
-    "bin/jaccard"
+    "bin",
+    "lib"
   ],
-  "preferUnplugged": true,
+  "engines": {
+    "node": ">=18"
+  },
   "publishConfig": {
     "access": "public"
+  },
+  "optionalDependencies": {
+    "@jaccard-ai/cli-darwin-arm64": "npm:@jaccard-ai/cli@0.6.0-darwin-arm64",
+    "@jaccard-ai/cli-darwin-x64": "npm:@jaccard-ai/cli@0.6.0-darwin-x64",
+    "@jaccard-ai/cli-linux-arm64": "npm:@jaccard-ai/cli@0.6.0-linux-arm64",
+    "@jaccard-ai/cli-linux-x64": "npm:@jaccard-ai/cli@0.6.0-linux-x64"
   }
 }