/** * Build-pipeline emitters for the Impeccable design hook. * * Two emission targets exist: * * 1. Project-local install (the `npx impeccable skills install` CLI path): * - Claude Code: `.claude/settings.json` (${CLAUDE_PROJECT_DIR}-relative) * - Codex: `.codex/hooks.json` * - Cursor: `.cursor/hooks.json` * - Grok Build: `.grok/hooks/impeccable.json` * * 2. Claude Code plugin package (the marketplace / `/plugin install` path): * - `plugin/hooks/hooks.json` (${CLAUDE_PLUGIN_ROOT}-relative) * Also consumed by Grok Build via Claude Code plugin compatibility * (`CLAUDE_PLUGIN_ROOT` is aliased to `GROK_PLUGIN_ROOT`). * * 3. OpenAI plugin package: * - `hooks/hooks.json` (${PLUGIN_ROOT}-relative) * * The plugin variant resolves the hook script relative to the installed plugin * root rather than assuming a `.claude/skills/impeccable/` layout, so it stays * correct wherever Claude Code unpacks the plugin. */ export const IMPECCABLE_HOOK_COMMAND_MARKER = 'skills/impeccable/scripts/impeccable'; const TIMEOUT_SECONDS = 5; const STATUS_MESSAGE = 'Checking UI changes'; // The Stop deep pass scans every UI file touched in the session with the // full rule set, so it gets a longer budget than the single-file per-edit // pass. Wired only for Claude Code and Codex, which both dispatch a native // `Stop` hook event; Cursor's stop hook is not consistently dispatched and // GitHub Copilot's stop-style events do not feed context back to the model. const STOP_TIMEOUT_SECONDS = 30; const STOP_STATUS_MESSAGE = 'Design deep pass'; // The hook is a verb of the impeccable launcher that ships in the skill's // scripts dir: `/impeccable hook` (per-edit and Stop passes) and // `/impeccable hook-before-edit` (Cursor's preToolUse). The launcher // runs the platform binary next to it, or downloads it once; no runtime probe // is needed and there is no Node on the path to check. export const LAUNCHER_NAME = 'impeccable'; export const LAUNCHER_NAME_WINDOWS = 'impeccable.cmd'; // A hook manifest can be copied into a user-level settings file (issue #399: // user-level hooks fire in every project, where a project-relative path may // not exist). Guard the invocation so a missing launcher exits 0 without // swallowing the hook's real exit code when it is present: the `[ ! -f X ] || // X verb` form (not `... || true`) preserves the launcher's exit code, so // Claude's exit-2 blocking signal still reaches the agent. export const guardedLauncher = (launcherPath, verb = 'hook') => `[ ! -f "${launcherPath}" ] || "${launcherPath}" ${verb}`; // cmd.exe form for harnesses that read a `commandWindows` sibling (Codex // 0.146.0+ selects it on Windows; issue #452). `exit /b` forwards the // launcher's errorlevel. Paths keep forward slashes; cmd.exe accepts them in // quoted paths and it is the form the CLI already writes. export const windowsLauncherCommand = (launcherCmdPath, verb = 'hook') => `if exist "${launcherCmdPath}" ("${launcherCmdPath}" ${verb} & exit /b)`; function stopEntry(command, commandWindows) { return { hooks: [ { type: 'command', command, ...(commandWindows ? { commandWindows } : {}), timeout: STOP_TIMEOUT_SECONDS, statusMessage: STOP_STATUS_MESSAGE, }, ], }; } const launcherIn = (scriptsDir) => `${scriptsDir}/${LAUNCHER_NAME}`; const launcherCmdIn = (scriptsDir) => `${scriptsDir}/${LAUNCHER_NAME_WINDOWS}`; const CLAUDE_PROJECT_SCRIPTS = '${CLAUDE_PROJECT_DIR}/.claude/skills/impeccable/scripts'; const CLAUDE_PLUGIN_SCRIPTS = '${CLAUDE_PLUGIN_ROOT}/skills/impeccable/scripts'; const CODEX_PLUGIN_SCRIPTS = '${PLUGIN_ROOT}/skills/impeccable/scripts'; // Codex reads project hooks from `.codex/hooks.json`, but the skill payload the // hook invokes lives under the install's own skills dir: a `.codex`-directory // install keeps it at `.codex/skills/...`, while a `.agents` (Codex repo-skills) // install keeps it at `.agents/skills/...`. Derive the path from the install dir // so each generated manifest points at its own payload rather than a hardcoded // `.agents`; otherwise the guarded hook silently no-ops on `.codex` installs. const codexProjectScripts = (skillDir) => `${skillDir}/skills/impeccable/scripts`; const CURSOR_SCRIPTS = '.cursor/skills/impeccable/scripts'; const GITHUB_PROJECT_SCRIPTS = '$(git rev-parse --show-toplevel)/.github/skills/impeccable/scripts'; // Grok project hooks are relative to the git/workspace root. Claude tool names // in the matcher (Edit|Write|MultiEdit) alias to Grok's search_replace family. const GROK_PROJECT_SCRIPTS = '.grok/skills/impeccable/scripts'; // `windows: true` adds the `commandWindows` sibling; only Codex-shaped // consumers honor it, and an unknown key would fail Codex's strict parser if // it were the other way round, so it stays opt-in per manifest. function buildClaudeCompatibleHooks(matcher, scriptsDir, { windows = false } = {}) { const command = guardedLauncher(launcherIn(scriptsDir)); const commandWindows = windows ? windowsLauncherCommand(launcherCmdIn(scriptsDir)) : undefined; return { PostToolUse: [ { matcher, hooks: [ { type: 'command', command, ...(commandWindows ? { commandWindows } : {}), timeout: TIMEOUT_SECONDS, statusMessage: STATUS_MESSAGE, }, ], }, ], Stop: [stopEntry(command, commandWindows)], }; } export function buildClaudeSettingsManifest() { return { description: 'Impeccable design detector: immediate-tier checks after Edit/Write on UI files, full-rule deep pass on Stop.', hooks: buildClaudeCompatibleHooks('Edit|Write', CLAUDE_PROJECT_SCRIPTS), }; } // Plugin-packaged variant of the Claude hook. Claude Code reads the `hooks` // object from a plugin's `hooks/hooks.json`, and the command resolves relative // to ${CLAUDE_PLUGIN_ROOT} so it does not depend on the skill being copied into // `.claude/skills/`. No top-level `description`: Codex also loads bundled plugin // hooks from `hooks/hooks.json` and its strict parser rejects any field other // than `hooks`, failing the whole manifest (issue #330). export function buildClaudePluginHooksManifest() { return { hooks: buildClaudeCompatibleHooks('Edit|Write', CLAUDE_PLUGIN_SCRIPTS), }; } // OpenAI plugin-packaged variant. Codex exposes ${PLUGIN_ROOT} for resources // inside the installed plugin, so the public bundle can use the native path // instead of relying on its Claude compatibility alias. export function buildCodexPluginHooksManifest() { return { hooks: buildClaudeCompatibleHooks('Edit|Write|apply_patch', CODEX_PLUGIN_SCRIPTS, { windows: true }), }; } // `skillDir` is the install's own dot-directory (a provider's configDir), so the // emitted command points at that install's payload. Defaults to `.codex` for the // Codex provider, whose self-consistent bundle keeps the skill at `.codex/skills`. export function buildCodexHooksManifest(skillDir = '.codex') { return { hooks: buildClaudeCompatibleHooks('Edit|Write|apply_patch', codexProjectScripts(skillDir), { windows: true }), }; } export function buildCursorHooksManifest(scriptsDir = CURSOR_SCRIPTS) { return { version: 1, hooks: { preToolUse: [ { command: guardedLauncher(launcherIn(scriptsDir), 'hook-before-edit'), timeout: TIMEOUT_SECONDS, }, ], }, }; } // GitHub Copilot reads project hooks from `.github/hooks/*.json`. Its schema // differs from Claude/Codex/Cursor: the event key is lowercase `postToolUse`, // each entry is flat (no nested `hooks` array), the command lives under `bash` // (with an optional `powershell` sibling), the timeout key is `timeoutSec`, and // `matcher` is a full-match regex (`^(?:PATTERN)$`) tested against the tool name. // Copilot's file-editing tool names vary by surface (verified against CLI // 1.0.63): `copilot -p` runs use `edit` ({path, old_str, new_str}) and `create` // ({path, file_text}); interactive sessions and the cloud agent use // `apply_patch` (a raw OpenAI-format patch string). The matcher covers all // three. The same manifest is honored by both the CLI and the cloud/app agent. // https://docs.github.com/en/copilot/reference/hooks-reference export function buildGitHubHooksManifest() { return { version: 1, hooks: { postToolUse: [ { type: 'command', matcher: 'edit|create|apply_patch', bash: guardedLauncher(launcherIn(GITHUB_PROJECT_SCRIPTS)), timeoutSec: TIMEOUT_SECONDS, }, ], }, }; } // Grok Build discovers project hooks from `.grok/hooks/*.json` and requires // folder trust (`/hooks-trust` or `--trust`) before they run. Event schema is // Claude-compatible (PostToolUse / Stop / PreToolUse); Claude tool names in // matchers are aliased to Grok tools (Edit|Write|MultiEdit → search_replace). // https://docs.x.ai/build/features/hooks export function buildGrokHooksManifest() { return { hooks: buildClaudeCompatibleHooks('Edit|Write|MultiEdit', GROK_PROJECT_SCRIPTS), }; } export function hooksJsonFor(provider, options = {}) { switch (provider) { case 'claude': return buildClaudeSettingsManifest(); case 'codex': return buildCodexHooksManifest(options.configDir || '.codex'); case 'cursor': return buildCursorHooksManifest(); case 'github': return buildGitHubHooksManifest(); case 'grok': return buildGrokHooksManifest(); default: return null; } }