Files
pbakaus_impeccable/tests/hook-build.test.mjs
T
Paul BakausandClaude Fable 5 bcf354cd0c Fix Codex hook path so .codex-directory installs run the detector
The committed .codex/hooks.json hardcoded .agents/skills/impeccable/scripts/
hook.mjs. On a .codex-directory install the skill payload lives at .codex/
skills/..., so the guarded command ([ ! -f X ] || node X) found no file and
silently no-opped, leaving the design detector dead for those users.

Derive the hook payload path from the emitting provider's own configDir rather
than hardcoding .agents:

- buildCodexHooksManifest(skillDir) now builds `${skillDir}/skills/impeccable/
  scripts/hook.mjs`; hooksJsonFor threads each provider's configDir through. The
  Codex provider (configDir .codex) emits .codex/skills; the root sync and the
  self-consistent dist/codex bundle both point at their own payload.
- CLI installer: project-scope hook rewriting now derives the provider's own
  project-relative path instead of preserving the bundle token. The Codex bundle
  ships a .codex/skills command, but the CLI lays the skill at .agents/skills, so
  the installed .codex/hooks.json is rewritten to .agents/skills (Claude keeps
  its ${CLAUDE_PROJECT_DIR} token; global installs keep the absolute rewrite).

Per-provider hook payload path after the fix:

  Emission                              hook path
  dist/codex/.codex/hooks.json          .codex/skills/impeccable/scripts/hook.mjs
  root .codex/hooks.json (build sync)   .codex/skills/impeccable/scripts/hook.mjs
  CLI .agents (codex) project install   .agents/skills/impeccable/scripts/hook.mjs
  CLI .agents (codex) global install    <home>/.agents/skills/.../hook.mjs (abs)
  .claude / .cursor                     unchanged

Tests: extended hook-build (codex-dir -> .codex/skills, agents-dir -> .agents/
skills) and skills-cli (bundle ships .codex/skills, install rewrites to .agents/
skills). Regenerated tracked .codex/hooks.json via build:release.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-24 17:09:33 -07:00

324 lines
15 KiB
JavaScript

/**
* Integration tests for the design-hook build pipeline.
* Run: node --test tests/hook-build.test.mjs
*/
import { describe, it } from 'node:test';
import assert from 'node:assert/strict';
import fs from 'node:fs';
import path from 'node:path';
import { fileURLToPath, pathToFileURL } from 'node:url';
import {
buildClaudeSettingsManifest,
buildClaudePluginHooksManifest,
buildCodexHooksManifest,
buildCursorHooksManifest,
buildGitHubHooksManifest,
buildGrokHooksManifest,
hooksJsonFor,
} from '../scripts/lib/transformers/hooks.js';
const REPO_ROOT = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
function readJson(rel) {
return JSON.parse(fs.readFileSync(path.join(REPO_ROOT, rel), 'utf8'));
}
function expectCommand(command, expectedPath) {
assert.equal(typeof command, 'string');
// node-command providers carry the missing-file guard (issue #399: exits 0
// when absent, preserves node's exit code when present); github/grok keep
// their own portable unguarded forms.
if (command.startsWith('[ ! -f "')) {
assert.match(command, /\|\| node "/);
} else {
assert.match(command, /^node "|^bash -c|\$\(git rev-parse/);
}
assert.ok(command.includes(expectedPath), `missing ${expectedPath} in ${command}`);
assert.ok(!command.includes('hook-probe.mjs'), `probe hook still referenced in ${command}`);
}
describe('hook manifest builders', () => {
it('builds Claude project settings for the real detector hook', () => {
const manifest = buildClaudeSettingsManifest();
const group = manifest.hooks.PostToolUse[0];
const handler = group.hooks[0];
assert.equal(group.matcher, 'Edit|Write|MultiEdit');
assert.equal(handler.type, 'command');
assert.equal(handler.timeout, 5);
assert.equal(handler.statusMessage, 'Checking UI changes');
expectCommand(handler.command, '.claude/skills/impeccable/scripts/hook.mjs');
assert.ok(handler.command.includes('${CLAUDE_PROJECT_DIR}'));
assert.equal(handler.args, undefined);
assert.equal(manifest.hooks.SessionStart, undefined);
// Stop deep pass: same script, no matcher, longer budget.
const stop = manifest.hooks.Stop[0].hooks[0];
assert.equal(manifest.hooks.Stop[0].matcher, undefined);
assert.equal(stop.timeout, 30);
assert.equal(stop.statusMessage, 'Design deep pass');
expectCommand(stop.command, '.claude/skills/impeccable/scripts/hook.mjs');
});
it('builds Codex project-local hooks for the real detector hook', () => {
// Default install dir is `.codex`: a `.codex`-directory install keeps the
// skill payload at `.codex/skills/...`, so the hook must point there (not at
// a hardcoded `.agents`, which no-ops on such installs).
const manifest = buildCodexHooksManifest();
assert.equal(manifest.description, undefined);
const group = manifest.hooks.PostToolUse[0];
const handler = group.hooks[0];
assert.equal(group.matcher, 'Edit|Write|apply_patch');
assert.equal(handler.type, 'command');
assert.equal(handler.timeout, 5);
assert.equal(handler.statusMessage, 'Checking UI changes');
expectCommand(handler.command, '.codex/skills/impeccable/scripts/hook.mjs');
assert.ok(!handler.command.includes('git rev-parse --show-toplevel'));
assert.ok(!handler.command.includes('${PLUGIN_ROOT}'));
assert.equal(manifest.hooks.SessionStart, undefined);
// Codex dispatches a native Stop event (turn scope), so it gets the deep
// pass too.
const stop = manifest.hooks.Stop[0].hooks[0];
assert.equal(stop.timeout, 30);
expectCommand(stop.command, '.codex/skills/impeccable/scripts/hook.mjs');
});
it('derives the Codex hook payload path from the install dir', () => {
// Each install dir gets a manifest pointing at its own skills payload: a
// `.codex`-directory install at `.codex/skills`, a `.agents` (Codex repo
// skills) install at `.agents/skills`.
const codexDir = buildCodexHooksManifest('.codex');
expectCommand(codexDir.hooks.PostToolUse[0].hooks[0].command, '.codex/skills/impeccable/scripts/hook.mjs');
expectCommand(codexDir.hooks.Stop[0].hooks[0].command, '.codex/skills/impeccable/scripts/hook.mjs');
const agentsDir = buildCodexHooksManifest('.agents');
expectCommand(agentsDir.hooks.PostToolUse[0].hooks[0].command, '.agents/skills/impeccable/scripts/hook.mjs');
expectCommand(agentsDir.hooks.Stop[0].hooks[0].command, '.agents/skills/impeccable/scripts/hook.mjs');
assert.ok(!agentsDir.hooks.PostToolUse[0].hooks[0].command.includes('.codex/skills'));
// hooksJsonFor threads the provider's configDir through to the builder.
expectCommand(
hooksJsonFor('codex', { configDir: '.agents' }).hooks.PostToolUse[0].hooks[0].command,
'.agents/skills/impeccable/scripts/hook.mjs',
);
expectCommand(
hooksJsonFor('codex').hooks.PostToolUse[0].hooks[0].command,
'.codex/skills/impeccable/scripts/hook.mjs',
);
});
it('builds one Cursor pre-write blocking hook', () => {
const manifest = buildCursorHooksManifest();
const beforeEdit = manifest.hooks.preToolUse[0];
assert.equal(manifest.version, 1);
assert.ok(Array.isArray(manifest.hooks.preToolUse));
assert.equal(Object.keys(manifest.hooks).length, 1);
assert.equal(manifest.hooks.afterFileEdit, undefined);
assert.equal(manifest.hooks.stop, undefined);
assert.equal(manifest.hooks.sessionStart, undefined);
expectCommand(beforeEdit.command, '.cursor/skills/impeccable/scripts/hook-before-edit.mjs');
assert.equal(beforeEdit.timeout, 5);
});
it('builds GitHub Copilot repo-level hooks for the real detector hook', () => {
const manifest = buildGitHubHooksManifest();
const entry = manifest.hooks.postToolUse[0];
// GitHub's schema: flat entries (no nested `hooks`), lowercase event key,
// `bash`/`timeoutSec`, and a full-match `matcher` against the tool name.
assert.equal(manifest.version, 1);
assert.equal(Object.keys(manifest.hooks).length, 1);
assert.equal(entry.type, 'command');
assert.equal(entry.matcher, 'edit|create|apply_patch');
assert.equal(entry.timeoutSec, 5);
assert.equal(entry.timeout, undefined);
assert.equal(entry.command, undefined);
expectCommand(entry.bash, '.github/skills/impeccable/scripts/hook.mjs');
assert.ok(entry.bash.includes('git rev-parse --show-toplevel'));
assert.equal(manifest.hooks.PostToolUse, undefined);
assert.equal(manifest.hooks.preToolUse, undefined);
});
it('builds Grok Build project hooks for the real detector hook', () => {
const manifest = buildGrokHooksManifest();
const group = manifest.hooks.PostToolUse[0];
const handler = group.hooks[0];
// Claude-compatible schema; Claude tool names alias to Grok tools at runtime.
assert.equal(group.matcher, 'Edit|Write|MultiEdit');
assert.equal(handler.type, 'command');
assert.equal(handler.timeout, 5);
assert.equal(handler.statusMessage, 'Checking UI changes');
expectCommand(handler.command, '.grok/skills/impeccable/scripts/hook.mjs');
assert.ok(!handler.command.includes('${CLAUDE_PROJECT_DIR}'));
assert.ok(!handler.command.includes('${GROK_PLUGIN_ROOT}'));
assert.equal(manifest.hooks.SessionStart, undefined);
const stop = manifest.hooks.Stop[0].hooks[0];
assert.equal(stop.timeout, 30);
assert.equal(stop.statusMessage, 'Design deep pass');
expectCommand(stop.command, '.grok/skills/impeccable/scripts/hook.mjs');
});
it('routes supported hook builders and leaves other providers alone', () => {
assert.ok(hooksJsonFor('claude'));
assert.ok(hooksJsonFor('codex'));
assert.ok(hooksJsonFor('cursor'));
assert.ok(hooksJsonFor('github'));
assert.ok(hooksJsonFor('grok'));
assert.equal(hooksJsonFor('gemini'), null);
});
});
describe('generated hook artifacts in repo', () => {
for (const rel of [
'.claude/settings.json',
'.cursor/hooks.json',
'.codex/hooks.json',
'.github/hooks/impeccable.json',
]) {
it(`${rel} exists and is valid JSON`, () => {
const abs = path.join(REPO_ROOT, rel);
assert.ok(fs.existsSync(abs), `${rel} missing - did you forget bun run build?`);
assert.doesNotThrow(() => JSON.parse(fs.readFileSync(abs, 'utf8')));
});
}
it('root hook manifests exactly match the hook builders', () => {
assert.deepEqual(readJson('.claude/settings.json'), buildClaudeSettingsManifest());
assert.deepEqual(readJson('.cursor/hooks.json'), buildCursorHooksManifest());
assert.deepEqual(readJson('.codex/hooks.json'), buildCodexHooksManifest());
assert.deepEqual(readJson('.github/hooks/impeccable.json'), buildGitHubHooksManifest());
});
it('Claude project settings reference hook.mjs in .claude/skills', () => {
const manifest = readJson('.claude/settings.json');
const handler = manifest.hooks.PostToolUse[0].hooks[0];
expectCommand(handler.command, '.claude/skills/impeccable/scripts/hook.mjs');
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.claude/skills/impeccable/scripts/hook.mjs')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.claude/skills/impeccable/scripts/hook-lib.mjs')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.claude/skills/impeccable/scripts/detector/detect-antipatterns.mjs')));
});
it('Cursor project hooks reference only the pre-write runtime in .cursor/skills', () => {
const manifest = readJson('.cursor/hooks.json');
const beforeEdit = manifest.hooks.preToolUse[0];
assert.equal(Object.keys(manifest.hooks).length, 1);
expectCommand(beforeEdit.command, '.cursor/skills/impeccable/scripts/hook-before-edit.mjs');
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.cursor/skills/impeccable/scripts/hook-before-edit.mjs')));
assert.equal(fs.existsSync(path.join(REPO_ROOT, '.cursor/skills/impeccable/scripts/hook-after-edit.mjs')), false);
assert.equal(fs.existsSync(path.join(REPO_ROOT, '.cursor/skills/impeccable/scripts/hook-stop.mjs')), false);
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.cursor/skills/impeccable/scripts/hook-lib.mjs')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.cursor/skills/impeccable/scripts/detector/detect-antipatterns.mjs')));
});
it('Codex project hooks reference hook.mjs in the .codex skill payload', () => {
// The committed `.codex/hooks.json` is the distribution artifact for a
// `.codex`-directory install, whose skill payload lives at `.codex/skills/`
// (issue: it previously hardcoded `.agents/skills`, so the guarded hook
// no-opped on `.codex` installs). CLI installs that lay the skill down at
// `.agents/skills` rewrite the command to that path at install time.
const manifest = readJson('.codex/hooks.json');
const handler = manifest.hooks.PostToolUse[0].hooks[0];
expectCommand(handler.command, '.codex/skills/impeccable/scripts/hook.mjs');
assert.ok(!handler.command.includes('.agents/skills'));
// The self-consistent Codex bundle ships the payload the manifest targets.
assert.ok(fs.existsSync(path.join(REPO_ROOT, 'dist/codex/.codex/skills/impeccable/SKILL.md')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, 'dist/codex/.codex/skills/impeccable/scripts/hook.mjs')));
// The repo also ships the Codex skill payload at `.agents/skills` (the
// layout CLI installs use, and where the rewritten command resolves).
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.agents/skills/impeccable/SKILL.md')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.agents/skills/impeccable/scripts/hook.mjs')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.agents/skills/impeccable/scripts/hook-lib.mjs')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.agents/skills/impeccable/scripts/detector/detect-antipatterns.mjs')));
});
it('GitHub Copilot repo hooks reference hook.mjs in the .github skill payload', () => {
const manifest = readJson('.github/hooks/impeccable.json');
const entry = manifest.hooks.postToolUse[0];
assert.equal(entry.matcher, 'edit|create|apply_patch');
expectCommand(entry.bash, '.github/skills/impeccable/scripts/hook.mjs');
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.github/skills/impeccable/SKILL.md')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.github/skills/impeccable/scripts/hook.mjs')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.github/skills/impeccable/scripts/hook-lib.mjs')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, '.github/skills/impeccable/scripts/detector/detect-antipatterns.mjs')));
});
it('does not generate probe scripts into provider skill payloads', () => {
for (const providerDir of ['.claude', '.cursor', '.agents', 'plugin']) {
const probe = path.join(REPO_ROOT, providerDir, 'skills', 'impeccable', 'scripts', 'hook-probe.mjs');
assert.equal(fs.existsSync(probe), false, `${providerDir} still has hook-probe.mjs`);
}
});
it('does not generate stale Codex hook packaging artifacts', () => {
for (const rel of [
'.claude/hooks/hooks.json',
'.agents/hooks',
'.agents/plugins/marketplace.json',
'plugin/.codex-plugin',
'plugin/assets',
'plugin-codex',
]) {
assert.equal(fs.existsSync(path.join(REPO_ROOT, rel)), false, `${rel} should not exist`);
}
});
it('packages the Claude design hook in the plugin via plugin-root paths', () => {
const abs = path.join(REPO_ROOT, 'plugin/hooks/hooks.json');
assert.ok(fs.existsSync(abs), 'plugin/hooks/hooks.json missing - did you forget bun run build:release?');
const manifest = readJson('plugin/hooks/hooks.json');
assert.deepEqual(manifest, buildClaudePluginHooksManifest());
// Codex loads bundled plugin hooks from this same file and rejects any
// top-level field other than `hooks` (issue #330).
assert.equal(manifest.description, undefined);
const handler = manifest.hooks.PostToolUse[0].hooks[0];
assert.equal(manifest.hooks.PostToolUse[0].matcher, 'Edit|Write|MultiEdit');
expectCommand(handler.command, 'skills/impeccable/scripts/hook.mjs');
// Resolves relative to the installed plugin, not a `.claude/skills/` layout.
assert.ok(handler.command.includes('${CLAUDE_PLUGIN_ROOT}'),
`plugin hook command must use $\{CLAUDE_PLUGIN_ROOT}: ${handler.command}`);
assert.ok(!handler.command.includes('${CLAUDE_PROJECT_DIR}'),
`plugin hook command must not use $\{CLAUDE_PROJECT_DIR}: ${handler.command}`);
// Stop deep pass ships in the plugin manifest too, plugin-root-relative.
const stop = manifest.hooks.Stop[0].hooks[0];
assert.equal(stop.timeout, 30);
expectCommand(stop.command, 'skills/impeccable/scripts/hook.mjs');
assert.ok(stop.command.includes('${CLAUDE_PLUGIN_ROOT}'));
// The script the plugin hook points at must ship inside the plugin payload.
assert.ok(fs.existsSync(path.join(REPO_ROOT, 'plugin/skills/impeccable/scripts/hook.mjs')));
assert.ok(fs.existsSync(path.join(REPO_ROOT, 'plugin/skills/impeccable/scripts/hook-lib.mjs')));
});
it('generated hook runtime can import the bundled detector', async () => {
for (const scriptDir of [
'.claude/skills/impeccable/scripts',
'.cursor/skills/impeccable/scripts',
'.agents/skills/impeccable/scripts',
'plugin/skills/impeccable/scripts',
]) {
const abs = path.join(REPO_ROOT, scriptDir);
assert.ok(fs.existsSync(path.join(abs, 'detector', 'detect-antipatterns.mjs')),
`detector bundle missing in ${scriptDir}`);
const hookLib = await import(pathToFileURL(path.join(abs, 'hook-lib.mjs')));
const detector = await hookLib.loadDetector();
assert.equal(typeof detector.detectText, 'function');
}
});
});