@fusion.dev/helix-cli 0.24.0 → 0.25.0

package/README.md

@@ -7,6 +7,12 @@ derives themes, scaffolds a project, and serves the derivation to an agent.
 npm install --save-dev @fusion.dev/helix-cli
 ```
 
+The command is a native binary, and npm installs the build for your machine
+beside this package: macOS and Linux on Arm and x86-64, and Windows on x86-64.
+An install that skips optional dependencies skips it too, and `helix` then names
+the package it's missing. To start a project rather than add Helix to one, use
+`npm create @fusion.dev/helix-app`.
+
 ```sh
 helix component check      # the CI shape: nothing printed on success
 helix component audit      # every rule and what it found

package/bin.mjs

@@ -15,9 +15,11 @@
  * **Resolution order, and each step is there for a reason.** `HELIX_BIN` first,
  * because a caller that knows better should not have to argue. Then the cargo
  * target directory, release before debug, honoring `CARGO_TARGET_DIR` because a
- * shared target is common and guessing `./target` would miss it. Then whatever
- * is on `PATH`, which is what an installed binary looks like. Only then a
- * build, and only when cargo is present.
+ * shared target is common and guessing `./target` would miss it. Then the
+ * binary npm installed beside this, which is what a consumer has: after the
+ * target, so a checkout runs what it built rather than a binary a release once
+ * placed. Then whatever is on `PATH`. Only then a build, and only in this
+ * repository, the one place there is a crate to build.
  *
  * **A build is a fallback and not the plan.** It happens once, prints that it
  * is happening, and a CI pipeline that has already run `cargo build` never
@@ -27,6 +29,7 @@
  */
 import { spawnSync } from 'node:child_process'
 import { existsSync, realpathSync, statSync } from 'node:fs'
+import { createRequire } from 'node:module'
 import { delimiter, dirname, join, resolve } from 'node:path'
 import { fileURLToPath } from 'node:url'
 
@@ -57,6 +60,34 @@ const built = () =>
     .sort((a, b) => statSync(b).mtimeMs - statSync(a).mtimeMs)
     .at(0)
 
+/**
+ * The platform package npm installed for this machine, named as they are
+ * published: `@fusion.dev/helix-cli-darwin-arm64` and the rest.
+ */
+const PLATFORM = `@fusion.dev/helix-cli-${process.platform}-${process.arch}`
+
+/**
+ * The binary in this machine's platform package, or undefined.
+ *
+ * **One of several optional dependencies, and npm installs only the one whose
+ * `os` and `cpu` match**, which is how Biome and esbuild ship a native binary
+ * without a download of their own. Resolved as a module, so it is found
+ * wherever the package manager put it, hoisted or not.
+ */
+const packaged = () => {
+  let manifest
+  try {
+    manifest = createRequire(import.meta.url).resolve(`${PLATFORM}/package.json`)
+  } catch {
+    return undefined
+  }
+  const binary = join(dirname(manifest), NAME)
+  return existsSync(binary) ? binary : undefined
+}
+
+/** Whether this is the repository's own copy, where there is a crate to build. */
+const checkout = existsSync(join(CRATE, 'Cargo.toml'))
+
 /** Whether cargo is on the path, asked once and cheaply. */
 const hasCargo = () => spawnSync('cargo', ['--version'], { stdio: 'ignore' }).status === 0
 
@@ -114,14 +145,17 @@ const onPath = () => {
 
 const run = (binary) => {
   const { status, error } = spawnSync(binary, process.argv.slice(2), { stdio: 'inherit' })
-  if (error) {
+  /* A status means it ran. Bun sets `error` on any exit but zero, to a
+     `SystemError` reading "null", so asking `error` alone reported every failed
+     check as a binary that would not start, and exited 70 for its 1. */
+  if (error && status === null) {
     console.error(`helix: could not run \`${binary}\`: ${error.message}`)
     process.exit(70)
   }
   process.exit(status ?? 70)
 }
 
-const found = process.env.HELIX_BIN ?? built()
+const found = process.env.HELIX_BIN ?? built() ?? packaged()
 if (found && existsSync(found)) {
   run(found)
 }
@@ -133,6 +167,21 @@ if (installed) {
   run(installed)
 }
 
+/* Installed from the registry, with no platform package for this machine. A
+   build would be `cargo build` in somebody else's project, for a crate that is
+   not in it. */
+if (!checkout) {
+  console.error(
+    `helix: no binary for ${process.platform} ${process.arch}.\n\n` +
+      `  It comes in \`${PLATFORM}\`, an optional dependency of\n` +
+      '  `@fusion.dev/helix-cli`, and it is not installed. Either this machine is not\n' +
+      '  one there is a build for, or the install skipped optional dependencies\n' +
+      '  (`--omit=optional`, `--no-optional`), in which case install again without it.\n' +
+      '  `HELIX_BIN` names a binary to run instead.',
+  )
+  process.exit(69)
+}
+
 if (!hasCargo()) {
   console.error(
     'helix: no binary and no cargo.\n\n' +

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@fusion.dev/helix-cli",
   "description": "The Helix command line, for a workspace that reaches it through npm.",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "license": "MIT",
   "author": "Ross Sheppard <ross.sheppard@fusion.dev>",
   "repository": {
@@ -28,6 +28,13 @@
     "scaffold",
     "theme"
   ],
+  "optionalDependencies": {
+    "@fusion.dev/helix-cli-darwin-arm64": "0.25.0",
+    "@fusion.dev/helix-cli-darwin-x64": "0.25.0",
+    "@fusion.dev/helix-cli-linux-arm64": "0.25.0",
+    "@fusion.dev/helix-cli-linux-x64": "0.25.0",
+    "@fusion.dev/helix-cli-win32-x64": "0.25.0"
+  },
   "publishConfig": {
     "access": "restricted"
   }