@xemahq/repo-build-tooling 0.23.0 → 0.24.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xemahq/repo-build-tooling",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "Dev-time build tooling shared by every Xema repository. Ships as plain ESM, depending only on @xemahq/release-policy for registry access, so the published artifact is the reviewed source.",
   "license": "Apache-2.0",
   "author": "Neuralchowder Inc. <developer@xema.dev> (https://xema.dev)",
@@ -25,6 +25,7 @@
     "xema-check-no-vendored-deps": "src/check-no-vendored-deps.mjs",
     "xema-check-workspace-ranges": "src/check-workspace-range-matches-local.mjs",
     "xema-composed-image": "src/composed-image.mjs",
+    "xema-install-git-hooks": "src/install-git-hooks.mjs",
     "xema-prepush-sanity": "src/prepush-sanity.mjs",
     "xema-promote-image": "src/promote-image.mjs",
     "xema-readiness": "src/readiness.mjs",
@@ -37,6 +38,7 @@
     "./check-no-vendored-deps": "./src/check-no-vendored-deps.mjs",
     "./check-workspace-range-matches-local": "./src/check-workspace-range-matches-local.mjs",
     "./composed-image": "./src/composed-image.mjs",
+    "./install-git-hooks": "./src/install-git-hooks.mjs",
     "./package.json": "./package.json",
     "./prepush-sanity": "./src/prepush-sanity.mjs",
     "./promote-image": "./src/promote-image.mjs",
@@ -46,12 +48,12 @@
     "./service-image": "./src/service-image.mjs"
   },
   "dependencies": {
-    "@xemahq/release-policy": "^14.0.0"
+    "@xemahq/release-policy": "^16.0.0"
   },
   "scripts": {
-    "test": "node src/scrub-swagger-plugin-paths.mjs --self-test && node --test src/check-workspace-range-matches-local.test.mjs && node --test src/check-no-vendored-deps.test.mjs && node --test src/readiness.test.mjs && node --test src/composed-image.test.mjs && node --test src/composed-image-coordinate-cli.test.mjs && node --test src/declaration-refusal.test.mjs && node --test src/smoke-refusal.test.mjs && node --test src/load-image.test.mjs && node --test src/composed-image-coordinate.test.mjs && node --test src/composed-image-dockerfile.test.mjs && node --test src/service-bootstrap.test.mjs && node --test src/service-bootstrap-protocols.test.mjs && node --test src/composed-image-prebuilt-dockerfile.test.mjs && node --test src/composed-image-in-image-closure.test.mjs && node --test src/composed-image-stage.test.mjs && node --test src/composed-image-pnpm-context.test.mjs && node --test src/composed-image-sync-injected.test.mjs && node --test src/composed-image-prisma-check.test.mjs && node --test src/composed-image-prisma-engine.test.mjs && node --test src/composed-migrate.test.mjs && node --test src/promote-image.test.mjs && node --test src/arm64-supplement-needed.test.mjs && node --test src/prepush-sanity.test.mjs && node --test src/service-image.test.mjs"
+    "test": "node src/scrub-swagger-plugin-paths.mjs --self-test && node --test src/check-workspace-range-matches-local.test.mjs && node --test src/check-no-vendored-deps.test.mjs && node --test src/readiness.test.mjs && node --test src/composed-image.test.mjs && node --test src/composed-image-coordinate-cli.test.mjs && node --test src/declaration-refusal.test.mjs && node --test src/smoke-refusal.test.mjs && node --test src/load-image.test.mjs && node --test src/composed-image-coordinate.test.mjs && node --test src/composed-image-dockerfile.test.mjs && node --test src/service-bootstrap.test.mjs && node --test src/service-bootstrap-protocols.test.mjs && node --test src/composed-image-prebuilt-dockerfile.test.mjs && node --test src/composed-image-in-image-closure.test.mjs && node --test src/composed-image-stage.test.mjs && node --test src/composed-image-pnpm-context.test.mjs && node --test src/composed-image-sync-injected.test.mjs && node --test src/composed-image-prisma-check.test.mjs && node --test src/composed-image-prisma-engine.test.mjs && node --test src/composed-migrate.test.mjs && node --test src/promote-image.test.mjs && node --test src/arm64-supplement-needed.test.mjs && node --test src/prepush-sanity.test.mjs && node --test src/service-image.test.mjs && node --test src/install-git-hooks.test.mjs"
   },
   "xemaRelease": {
-    "sourceDigest": "sha256:1e968ed2990de85680e206c3dcb98c5467bb3c01166ace6b1e81be91e5344fb1"
+    "sourceDigest": "sha256:5a6b2b46f5f22f0becd6c31ddb6992e245b73fd5d510228a90c51b30ac0ce8df"
   }
 }

package/src/install-git-hooks.mjs

@@ -0,0 +1,323 @@
+#!/usr/bin/env node
+// ═══════════════════════════════════════════════════════════════════════════
+// `xema-install-git-hooks` — run from `prepare`: install the lefthook git hooks, but only where hooks can exist.
+//
+// `prepare` runs on EVERY `pnpm install`, and one of those installs happens
+// inside the service Docker image build, which has neither a `.git` directory
+// (the build context excludes it) nor a `git` binary. A bare
+// `"prepare": "lefthook install"` therefore fails the image build outright:
+//
+//     . prepare: Error: exec: "git": executable file not found in $PATH
+//     ERROR: failed to solve: process "... pnpm install --offline
+//            --filter ${SERVICE}... --frozen-lockfile" exit code: 1
+//
+// That is not a hook problem to work around — it is a category error. Git
+// hooks are a property of a developer's WORKING TREE; an image build has no
+// working tree to hook, so there is nothing to install and nothing has gone
+// wrong. This script says exactly that, out loud, and exits 0.
+//
+// What it does NOT do is swallow a real failure. In an actual git work tree
+// the install must succeed: a non-zero `lefthook install` propagates, because
+// a developer whose pre-push hook silently failed to install is a developer
+// who finds out from CI instead. The two outcomes are distinguished by a
+// deterministic fact — "is there a git work tree here" — never by an `|| true`.
+//
+// ── WHY THIS SCRIPT RESOLVES THE BINARY ITSELF ────────────────────────────
+//
+// It used to `spawnSync('lefthook', …)`, i.e. rely on PATH / the caller's
+// `.bin/`. Inside the AGGREGATOR checkout that is unreachable for a carved
+// repository, and the failure was silent in both halves:
+//
+//   1. `lefthook install` bakes an ABSOLUTE path to the binary that ran it
+//      into the generated hook (measured: re-running `install` from a
+//      different binary rewrites that line). A carved repo's hook was baked by
+//      a `pnpm install` run INSIDE that repo — the escape hatch — so it points
+//      at `repos/<repo>/node_modules/.pnpm/lefthook-*/bin/lefthook`.
+//   2. That store is exactly what `.claude/rules/package-store-ownership.md`
+//      forbids and `tooling/dev/repair-package-stores.mjs` deletes. Afterwards
+//      the baked path dangles, and every remaining fallback in lefthook's
+//      generated hook misses too: lefthook is not on PATH, and a carved repo
+//      root is not an aggregator workspace member, so it has no `node_modules`
+//      and no `.bin/` at all.
+//   3. lefthook's generated hook ends its search with
+//      `echo "Can't find lefthook in PATH"` — and NO non-zero exit. So the
+//      hook printed a warning and returned 0. Measured 2026-08-17: every one
+//      of the ten carved repositories' `pre-push` hooks was in this state, so
+//      every local push in this checkout was unguarded while LOOKING guarded.
+//
+// The fix is the pattern `package-store-ownership.md` already documents for
+// carved root scripts: resolve by PATH-INDEPENDENT node resolution instead of
+// a binary name. `createRequire(...).resolve('lefthook/bin/index.js')` walks up
+// from this file — `repos/<repo>/node_modules` (absent) → the aggregator's
+// `node_modules` (present) — and in a standalone clone it finds the repo's own
+// copy on the first hop. Same script, both topologies, no per-machine config.
+//
+// ── AND WHY IT HARDENS THE GENERATED HOOK ─────────────────────────────────
+//
+// Resolving the binary fixes today's breakage. It does not fix the SHAPE of
+// the defect: a baked absolute path can dangle again — another store repair,
+// a `pnpm store prune`, a different machine, a moved checkout — and lefthook's
+// template would once more warn-and-return-0. A gate whose only failure mode
+// is a message nobody reads is the failure this repository names most often.
+//
+// So after installing, every generated hook's dead-end branch is rewritten to
+// print the reason and `exit 1`. An unresolvable lefthook now REFUSES the
+// push instead of waving it through; `git push --no-verify` remains the
+// deliberate, visible bypass.
+//
+// The rewrite ASSERTS rather than assumes: the marker must be present exactly
+// once in freshly generated content, and if lefthook's template ever changes
+// so it is not, this fails loudly instead of leaving hooks quietly unhardened.
+//
+// ── AND WHY IT SWEEPS SUBMODULES ──────────────────────────────────────────
+//
+// A carved repository's root is not an aggregator workspace member, so its own
+// `prepare` NEVER runs from an aggregator install — which is why the fix above
+// would otherwise be inert in the only checkout that has the bug. The
+// aggregator install already owns every `node_modules` beneath `repos/`
+// (`package-store-ownership.md`); it therefore owns the hooks baked against
+// them. Each submodule that carries a lefthook config gets the same install +
+// hardening, from the same resolved binary.
+//
+// In a standalone carved clone this loop is naturally inert — those
+// repositories have no submodules — so one byte-identical script serves both.
+// ═══════════════════════════════════════════════════════════════════════════
+
+import { spawnSync } from 'node:child_process';
+import { createRequire } from 'node:module';
+import { existsSync, readdirSync, readFileSync, statSync, writeFileSync } from 'node:fs';
+import { dirname, join, resolve } from 'node:path';
+
+/** Printed with a stable prefix so the reason is greppable in build logs. */
+const TAG = '[prepare:git-hooks]';
+
+/** The directory `prepare` runs in: the repository (or aggregator) root. */
+const ROOT = process.cwd();
+
+function skip(reason) {
+  console.log(`${TAG} skipped — ${reason}. Nothing to install here.`);
+  process.exit(0);
+}
+
+function die(message) {
+  console.error(`${TAG} ${message}`);
+  process.exit(1);
+}
+
+// ── 1. Is there anything to hook at all? ──────────────────────────────────
+//
+// `git rev-parse --git-dir` is the cheapest total answer to "is this a git
+// work tree": it is non-zero outside one, and ENOENT when git is absent
+// entirely. Both are the same verdict — no tree, no hooks.
+// This is a dev tool, not service code, so it may read the process env.
+if (process.env.CI === 'true' || process.env.GITHUB_ACTIONS === 'true') {
+  skip("CI runner: git hooks belong to a developer's working tree");
+}
+
+const probe = spawnSync('git', ['rev-parse', '--git-dir'], { stdio: 'ignore' });
+
+if (probe.error?.code === 'ENOENT') {
+  skip('no `git` executable on PATH (image build / CI container)');
+}
+if (probe.error) {
+  skip(`could not probe for a git work tree (${probe.error.message})`);
+}
+if (probe.status !== 0) {
+  skip('not inside a git work tree (installed as a dependency or tarball)');
+}
+
+// ── 2. One-time migration off the hand-rolled `.husky/` directory ─────────
+//
+// This repository used to point `core.hooksPath` at a tracked `.husky/`, wired
+// up by every developer running `git config core.hooksPath .husky` BY HAND —
+// which is why almost nobody was wired up. lefthook writes into `.git/hooks`,
+// and a stale `core.hooksPath` silently wins over it, so the install would
+// report success while no hook ever fired.
+//
+// Cleared ONLY when it points at a directory that no longer exists. A
+// `core.hooksPath` someone set deliberately, to somewhere real, is left alone.
+const hooksPath = spawnSync('git', ['config', '--get', 'core.hooksPath'], {
+  encoding: 'utf8',
+});
+const configured = (hooksPath.stdout ?? '').trim();
+if (configured.length > 0 && !existsSync(configured)) {
+  console.log(
+    `${TAG} clearing core.hooksPath -> ${configured} (that directory is gone; ` +
+      'it would silently win over the hooks installed below)',
+  );
+  const unset = spawnSync('git', ['config', '--unset', 'core.hooksPath'], {
+    stdio: 'inherit',
+  });
+  if (unset.status !== 0) {
+    die(
+      'could not clear core.hooksPath. Run `git config --unset core.hooksPath` ' +
+        'yourself, or the hooks below will not fire.',
+    );
+  }
+}
+
+// ── 3. Resolve the lefthook launcher, PATH-independently ──────────────────
+//
+// See the header. `lefthook`'s npm package exposes `bin/index.js`, a Node
+// launcher that execs the platform binary; the binary reports its OWN absolute
+// path to `lefthook install`, which is the path that gets baked into the hook.
+// So resolving the launcher is enough to fix what gets baked.
+//
+// Resolved from the repository root, not from this file: when installed as a
+// dependency this file lives in a package store that cannot see the repo's
+// own `lefthook` devDependency.
+const require = createRequire(join(ROOT, 'package.json'));
+
+let launcher;
+try {
+  launcher = require.resolve('lefthook/bin/index.js');
+} catch {
+  // Reachable when the tree was installed with `--ignore-scripts` semantics or
+  // a filtered/production install that omits root devDependencies. Loud, but
+  // not fatal: the hooks are a dev affordance, and the install itself is fine.
+  skip('`lefthook` is not installed (root devDependencies were not installed)');
+}
+
+// ── 4. Hardening the generated hook ───────────────────────────────────────
+
+/**
+ * lefthook's dead end. Present verbatim in every hook it generates (2.1.10),
+ * as the `else` arm of the binary search in `call_lefthook`. It prints and
+ * falls out of the function, so the hook exits 0 and the operation proceeds
+ * completely unverified.
+ */
+const DEAD_END = '      echo "Can\'t find lefthook in PATH"\n';
+
+/** Proof our rewrite is already applied — makes the pass idempotent. */
+const SENTINEL = '# xema:lefthook-unresolved-is-fatal';
+
+/**
+ * The replacement. Single-quoted so nothing in it is expanded by `sh`, and
+ * written to stderr because that is where a refusal belongs. `exit 1` inside a
+ * shell function exits the whole hook, which is exactly the intent.
+ */
+const REFUSAL = [
+  `      ${SENTINEL}`,
+  "      echo 'lefthook is installed as a git hook here, but its binary cannot' >&2",
+  "      echo 'be found — so THIS HOOK JUST VERIFIED NOTHING.' >&2",
+  "      echo '' >&2",
+  "      echo 'Refusing the operation rather than letting it through unguarded.' >&2",
+  "      echo '' >&2",
+  "      echo '  Fix: run `pnpm install` in the checkout that owns this tree' >&2",
+  "      echo '       node_modules. That re-runs prepare, which re-bakes this' >&2",
+  "      echo '       hook against a binary that exists.' >&2",
+  "      echo '  Deliberate bypass: git push --no-verify' >&2",
+  '      exit 1',
+  '',
+].join('\n');
+
+/**
+ * Rewrite one generated hook so an unresolvable lefthook is fatal.
+ * @returns {'hardened'|'already'} never silently "nothing to do".
+ */
+function hardenHookFile(file) {
+  const source = readFileSync(file, 'utf8');
+
+  if (source.includes(SENTINEL)) return 'already';
+
+  const occurrences = source.split(DEAD_END).length - 1;
+  if (occurrences !== 1) {
+    die(
+      `cannot harden ${file}: expected lefthook's "can't find" branch exactly ` +
+        `once, found ${occurrences}. lefthook's hook template has changed — ` +
+        're-derive this rewrite rather than leaving hooks unhardened.',
+    );
+  }
+
+  writeFileSync(file, source.replace(DEAD_END, REFUSAL), { mode: 0o755 });
+  return 'hardened';
+}
+
+// ── 5. Install + harden, here and in every hooked submodule ───────────────
+
+/** Absolute path to a work tree's hooks directory, per git itself. */
+function hooksDirOf(cwd) {
+  const out = spawnSync(
+    'git',
+    ['rev-parse', '--path-format=absolute', '--git-path', 'hooks'],
+    { cwd, encoding: 'utf8' },
+  );
+  if (out.status !== 0) return null;
+  const dir = (out.stdout ?? '').trim();
+  return dir.length > 0 ? dir : null;
+}
+
+function installIn(cwd, label) {
+  const install = spawnSync(process.execPath, [launcher, 'install'], {
+    cwd,
+    stdio: 'inherit',
+  });
+
+  if (install.error) {
+    die(`failed to run \`lefthook install\` in ${label}: ${install.error.message}`);
+  }
+  if (install.status !== 0) {
+    die(
+      `\`lefthook install\` exited ${install.status} in ${label}. Git hooks are ` +
+        'NOT installed; fix this rather than pushing without them.',
+    );
+  }
+
+  const dir = hooksDirOf(cwd);
+  if (dir === null || !existsSync(dir)) {
+    die(`\`lefthook install\` reported success in ${label} but ${dir ?? 'its hooks directory'} does not exist.`);
+  }
+
+  // Harden every hook lefthook generated — identified by the search function
+  // it writes, so a pre-existing hand-written hook is never touched.
+  let hardened = 0;
+  for (const name of readdirSync(dir)) {
+    if (name.endsWith('.sample')) continue;
+    const file = join(dir, name);
+    if (!statSync(file).isFile()) continue;
+    const body = readFileSync(file, 'utf8');
+    if (!body.includes('call_lefthook')) continue;
+    if (hardenHookFile(file) === 'hardened') hardened += 1;
+  }
+
+  if (hardened > 0) {
+    console.log(`${TAG} ${label}: hardened ${hardened} hook(s) — an unresolvable lefthook now exits 1.`);
+  }
+}
+
+installIn(ROOT, '.');
+
+// Submodules that carry their own lefthook config. Read from `.gitmodules`
+// rather than `git submodule foreach`, which would spawn a shell per entry
+// across a 28-submodule tree for a question two greps answer.
+const CONFIGS = ['lefthook.yml', 'lefthook.yaml', '.lefthook.yml', '.lefthook.yaml'];
+
+const gitmodules = resolve(ROOT, '.gitmodules');
+if (existsSync(gitmodules)) {
+  const listed = spawnSync(
+    'git',
+    ['config', '--file', gitmodules, '--get-regexp', String.raw`^submodule\..*\.path$`],
+    { encoding: 'utf8' },
+  );
+
+  // Exit 1 means "no matching keys", which is a legitimate empty answer.
+  if (listed.status !== 0 && listed.status !== 1) {
+    die(`could not read submodule paths from ${gitmodules} (exit ${listed.status}).`);
+  }
+
+  const paths = (listed.stdout ?? '')
+    .split('\n')
+    .map((line) => line.split(' ').slice(1).join(' ').trim())
+    .filter((p) => p.length > 0);
+
+  for (const rel of paths) {
+    const dir = resolve(dirname(gitmodules), rel);
+    if (!CONFIGS.some((name) => existsSync(join(dir, name)))) continue;
+    // An uninitialised submodule is an empty directory, not a work tree.
+    if (spawnSync('git', ['rev-parse', '--git-dir'], { cwd: dir, stdio: 'ignore' }).status !== 0) {
+      console.log(`${TAG} ${rel}: not initialised — skipping (run \`git submodule update --init\`).`);
+      continue;
+    }
+    installIn(dir, rel);
+  }
+}

package/src/install-git-hooks.test.mjs

@@ -0,0 +1,85 @@
+import assert from 'node:assert/strict';
+import { spawnSync } from 'node:child_process';
+import { mkdirSync, mkdtempSync, readFileSync, rmSync, writeFileSync, existsSync } from 'node:fs';
+import { tmpdir } from 'node:os';
+import { dirname, join } from 'node:path';
+import { after, describe, it } from 'node:test';
+import { fileURLToPath } from 'node:url';
+
+const SCRIPT = join(dirname(fileURLToPath(import.meta.url)), 'install-git-hooks.mjs');
+const made = [];
+
+after(() => {
+  for (const dir of made) rmSync(dir, { recursive: true, force: true });
+});
+
+function tempDir() {
+  const dir = mkdtempSync(join(tmpdir(), 'xema-hooks-'));
+  made.push(dir);
+  return dir;
+}
+
+function run(cwd, env = {}) {
+  const base = { ...process.env, CI: '', GITHUB_ACTIONS: '' };
+  return spawnSync(process.execPath, [SCRIPT], { cwd, env: { ...base, ...env }, encoding: 'utf8' });
+}
+
+/** A git work tree whose `lefthook` is a stub that writes a lefthook-shaped hook. */
+function repoWithFakeLefthook() {
+  const dir = tempDir();
+  spawnSync('git', ['init', '-q'], { cwd: dir });
+  writeFileSync(join(dir, 'package.json'), '{}');
+  const bin = join(dir, 'node_modules', 'lefthook', 'bin');
+  mkdirSync(bin, { recursive: true });
+  writeFileSync(join(dir, 'node_modules', 'lefthook', 'package.json'), '{"name":"lefthook"}');
+  writeFileSync(
+    join(bin, 'index.js'),
+    [
+      "const fs = require('node:fs');",
+      "fs.mkdirSync('.git/hooks', { recursive: true });",
+      "fs.writeFileSync('.git/hooks/pre-push', 'call_lefthook() {\\n  if x; then\\n    :\\n  else\\n      echo \"Can\\'t find lefthook in PATH\"\\n  fi\\n}\\n');",
+    ].join('\n'),
+  );
+  return dir;
+}
+
+describe('xema-install-git-hooks', () => {
+  for (const env of [{ CI: 'true' }, { GITHUB_ACTIONS: 'true' }]) {
+    it(`is a no-op on CI (${Object.keys(env)[0]})`, () => {
+      const dir = repoWithFakeLefthook();
+      const out = run(dir, env);
+      assert.equal(out.status, 0);
+      assert.match(out.stdout, /skipped — CI runner/);
+      assert.equal(existsSync(join(dir, '.git', 'hooks', 'pre-push')), false);
+    });
+  }
+
+  it('is a no-op outside a git work tree', () => {
+    const dir = tempDir();
+    const out = run(dir, { GIT_CEILING_DIRECTORIES: dirname(dir) });
+    assert.equal(out.status, 0);
+    assert.match(out.stdout, /not inside a git work tree/);
+  });
+
+  it('skips when lefthook is not installed', () => {
+    const dir = tempDir();
+    spawnSync('git', ['init', '-q'], { cwd: dir });
+    writeFileSync(join(dir, 'package.json'), '{}');
+    const out = run(dir);
+    assert.equal(out.status, 0);
+    assert.match(out.stdout, /`lefthook` is not installed/);
+  });
+
+  it('installs and hardens the hook outside CI, idempotently', () => {
+    const dir = repoWithFakeLefthook();
+    const first = run(dir);
+    assert.equal(first.status, 0, first.stderr);
+    assert.match(first.stdout, /hardened 1 hook/);
+    const hook = readFileSync(join(dir, '.git', 'hooks', 'pre-push'), 'utf8');
+    assert.match(hook, /xema:lefthook-unresolved-is-fatal/);
+    assert.match(hook, /exit 1/);
+    // Re-running regenerates then re-hardens; the stub rewrites the hook each time.
+    const second = run(dir);
+    assert.equal(second.status, 0, second.stderr);
+  });
+});