@phuc1403/musketeer 0.5.0 → 0.6.0

package/template/.claude/hooks/init-adr-dir.cjs

@@ -1,110 +1,153 @@
-#!/usr/bin/env node
-// PreToolUse guard: set up `.adr-dir` before the first `adr new` in a project,
-// so the agent never has to pick between `adr init` and a hand-written file.
-//
-// Two setup paths, and picking the wrong one is destructive:
-//   - fresh (no `.adr-dir`, no numbered ADRs yet): `adr init docs/adr` is safe —
-//     it creates docs/adr/, writes `.adr-dir`, and adds a baseline ADR.
-//   - migration (numbered ADRs already exist, but no `.adr-dir`): `adr init`
-//     would ALSO add that baseline ADR, burning the next real number. The fix
-//     is a plain `.adr-dir` file with no tool call: `printf 'docs/adr\n' > .adr-dir`.
-// Already initialized: nothing to do, both paths are a no-op.
-//
-// Runs the setup itself (as a side effect) before allowing `adr new` through,
-// and denies a *direct* `adr init` call whenever running it would be wrong —
-// already initialized, or migration state — since either would burn a number.
-// Anything it does is echoed to stdout so it stays visible in the transcript.
-
-const fs = require('fs');
-const path = require('path');
-const { spawnSync } = require('child_process');
-
-const root = process.env.CLAUDE_PROJECT_DIR || process.cwd();
-const ADR_DIR = 'docs/adr';
-const ADR_DIR_FILE = path.join(root, '.adr-dir');
-const ADR_FILE = /^\d+-.*\.md$/;
-
-function allow(message) {
-  if (message) process.stdout.write(message + '\n');
-  process.exit(0);
-}
-
-function deny(reason) {
-  process.stdout.write(
-    JSON.stringify({
-      hookSpecificOutput: {
-        hookEventName: 'PreToolUse',
-        permissionDecision: 'deny',
-        permissionDecisionReason: reason,
-      },
-    })
-  );
-  process.exit(0);
-}
-
-function isInitialized() {
-  try {
-    return fs.readFileSync(ADR_DIR_FILE, 'utf8').trim() !== '';
-  } catch {
-    return false;
-  }
-}
-
-function hasNumberedAdrs() {
-  try {
-    return fs.readdirSync(path.join(root, ADR_DIR)).some((f) => ADR_FILE.test(f));
-  } catch {
-    return false; // directory doesn't exist yet -> nothing to migrate
-  }
-}
-
-function runAdrInit() {
-  const shell = process.env.CLAUDE_CODE_GIT_BASH_PATH || 'bash';
-  return spawnSync(shell, ['-c', `adr init ${ADR_DIR}`], { cwd: root, encoding: 'utf8' });
-}
-
-function main() {
-  const payload = JSON.parse(fs.readFileSync(0, 'utf8'));
-  const command = payload?.tool_input?.command || '';
-  const isInit = /\badr\s+init\b/.test(command);
-  const isNew = /\badr\s+new\b/.test(command);
-  if (!isInit && !isNew) return allow();
-
-  if (isInitialized()) {
-    if (isInit) {
-      return deny(
-        '.adr-dir already exists — do not run `adr init` again, it would add a duplicate ' +
-          'baseline ADR and burn the next number. Run `adr new` directly.'
-      );
-    }
-    return allow(); // adr new, already set up: nothing to do
-  }
-
-  if (hasNumberedAdrs()) {
-    // Migration: numbered ADRs exist but `.adr-dir` does not. `adr init` would
-    // still add a baseline ADR here, so it is never the right command.
-    if (isInit) {
-      return deny(
-        'Numbered ADRs already exist without `.adr-dir` — this is a migration, not a fresh ' +
-          'project. `adr init` would add a duplicate baseline ADR and burn the next number. ' +
-          'Run `adr new` directly; `.adr-dir` is set up automatically.'
-      );
-    }
-    fs.writeFileSync(ADR_DIR_FILE, `${ADR_DIR}\n`);
-    return allow(`Migration detected: wrote .adr-dir (${ADR_DIR}) by hand, no baseline ADR added.`);
-  }
-
-  // Fresh project.
-  if (isInit) return allow(); // the agent's own `adr init` call is correct here — let it run
-  const res = runAdrInit();
-  if (res.error || res.status !== 0) {
-    return allow(`Could not run \`adr init ${ADR_DIR}\` (${res.error?.message || res.stderr}); letting the original command run and fail with its own error.`);
-  }
-  return allow(`Fresh project: ran \`adr init ${ADR_DIR}\` (creates the baseline ADR).`);
-}
-
-try {
-  main();
-} catch {
-  allow(); // fail open
-}
+#!/usr/bin/env node
+// PreToolUse guard: set up `.adr-dir` before the first `adr new` in a project,
+// so the agent never has to pick between `adr init` and a hand-written file.
+//
+// Two setup paths, and picking the wrong one is destructive:
+//   - fresh (no `.adr-dir`, no numbered ADRs yet): `adr init docs/adr` is safe —
+//     it creates docs/adr/, writes `.adr-dir`, and adds a baseline ADR.
+//   - migration (numbered ADRs already exist, but no `.adr-dir`): `adr init`
+//     would ALSO add that baseline ADR, burning the next real number. The fix
+//     is a plain `.adr-dir` file with no tool call: `printf 'docs/adr\n' > .adr-dir`.
+// Already initialized: nothing to do, both paths are a no-op.
+//
+// Runs the setup itself (as a side effect) before allowing `adr new` through,
+// and denies a *direct* `adr init` call whenever running it would be wrong —
+// already initialized, or migration state — since either would burn a number.
+// Anything it does is echoed to stdout so it stays visible in the transcript.
+
+const fs = require('fs');
+const path = require('path');
+const { spawnSync } = require('child_process');
+const { invokesAdr } = require('./lib/adr/command-scan.cjs');
+
+const root = process.env.CLAUDE_PROJECT_DIR || process.cwd();
+const ADR_DIR = 'docs/adr';
+const ADR_DIR_FILE = path.join(root, '.adr-dir');
+const ADR_FILE = /^\d+-.*\.md$/;
+
+function allow(message) {
+  if (message) process.stdout.write(message + '\n');
+  process.exit(0);
+}
+
+function deny(reason) {
+  process.stdout.write(
+    JSON.stringify({
+      hookSpecificOutput: {
+        hookEventName: 'PreToolUse',
+        permissionDecision: 'deny',
+        permissionDecisionReason: reason,
+      },
+    })
+  );
+  process.exit(0);
+}
+
+function readAdrDir() {
+  try {
+    return fs.readFileSync(ADR_DIR_FILE, 'utf8').trim() || null;
+  } catch {
+    return null;
+  }
+}
+
+function isInitialized() {
+  try {
+    return fs.readFileSync(ADR_DIR_FILE, 'utf8').trim() !== '';
+  } catch {
+    return false;
+  }
+}
+
+function hasNumberedAdrs() {
+  try {
+    return fs.readdirSync(path.join(root, ADR_DIR)).some((f) => ADR_FILE.test(f));
+  } catch {
+    return false; // directory doesn't exist yet -> nothing to migrate
+  }
+}
+
+function runAdrInit() {
+  const shell = process.env.CLAUDE_CODE_GIT_BASH_PATH || 'bash';
+  return spawnSync(shell, ['-c', `adr init ${ADR_DIR}`], { cwd: root, encoding: 'utf8' });
+}
+
+// Where adr-tools itself thinks the ADRs go. `_adr_dir` is the resolver every
+// adr subcommand uses, so asking it directly is the only honest answer.
+function resolvedAdrDir() {
+  const shell = process.env.CLAUDE_CODE_GIT_BASH_PATH || 'bash';
+  const res = spawnSync(shell, ['-c', '_adr_dir'], { cwd: root, encoding: 'utf8' });
+  if (res.error || res.status !== 0) return null;
+  const out = (res.stdout || '').trim();
+  return out || null;
+}
+
+// adr-tools resolves the directory with an unquoted `[` test, so a path holding
+// a space splits into too many arguments, the search loop is skipped, and the
+// script falls through to its `doc/adr` default. It prints the wrong answer on
+// stdout and exits 0, so the ADR lands in a directory nothing else looks at and
+// nothing reports a problem. Refuse the call instead of losing the record.
+function denyOnDirMismatch() {
+  const declared = readAdrDir();
+  const resolved = resolvedAdrDir();
+  if (!declared || !resolved || declared === resolved) return;
+
+  deny(
+    `adr-tools resolves the ADR directory to "${resolved}", but .adr-dir says "${declared}". ` +
+      `The new ADR would be written to "${resolved}", where the index hook never looks. ` +
+      (/\s/.test(root)
+        ? `This project's path contains a space (${root}), which is the known cause: ` +
+          "adr-tools' `_adr_dir` leaves its path test unquoted. "
+        : '') +
+      'Fix the quoting in adr-tools\' `_adr_dir`, or move the project to a path with no spaces.'
+  );
+}
+
+function main() {
+  const payload = JSON.parse(fs.readFileSync(0, 'utf8'));
+  const command = payload?.tool_input?.command || '';
+  const isInit = invokesAdr(command, 'init');
+  const isNew = invokesAdr(command, 'new');
+  if (!isInit && !isNew) return allow();
+
+  if (isInitialized()) {
+    if (isInit) {
+      return deny(
+        '.adr-dir already exists — do not run `adr init` again, it would add a duplicate ' +
+          'baseline ADR and burn the next number. Run `adr new` directly.'
+      );
+    }
+    denyOnDirMismatch(); // exits when adr-tools would write somewhere else
+    return allow(); // adr new, already set up: nothing to do
+  }
+
+  if (hasNumberedAdrs()) {
+    // Migration: numbered ADRs exist but `.adr-dir` does not. `adr init` would
+    // still add a baseline ADR here, so it is never the right command.
+    if (isInit) {
+      return deny(
+        'Numbered ADRs already exist without `.adr-dir` — this is a migration, not a fresh ' +
+          'project. `adr init` would add a duplicate baseline ADR and burn the next number. ' +
+          'Run `adr new` directly; `.adr-dir` is set up automatically.'
+      );
+    }
+    fs.writeFileSync(ADR_DIR_FILE, `${ADR_DIR}\n`);
+    denyOnDirMismatch();
+    return allow(`Migration detected: wrote .adr-dir (${ADR_DIR}) by hand, no baseline ADR added.`);
+  }
+
+  // Fresh project.
+  if (isInit) return allow(); // the agent's own `adr init` call is correct here — let it run
+  const res = runAdrInit();
+  if (res.error || res.status !== 0) {
+    return allow(`Could not run \`adr init ${ADR_DIR}\` (${res.error?.message || res.stderr}); letting the original command run and fail with its own error.`);
+  }
+  denyOnDirMismatch();
+  return allow(`Fresh project: ran \`adr init ${ADR_DIR}\` (creates the baseline ADR).`);
+}
+
+try {
+  main();
+} catch {
+  allow(); // fail open
+}

package/template/.claude/hooks/inject-adr-env.cjs

@@ -1,82 +1,83 @@
-#!/usr/bin/env node
-// PreToolUse guard: inject the env vars every `adr new` call needs, so the
-// agent can write a bare `adr new -- "Title"` and get a correct command.
-//
-//   VISUAL=true EDITOR=true  — without them an ambient EDITOR opens an
-//     interactive editor and hangs the session (adr-new always shells out to
-//     $VISUAL/$EDITOR to "edit" the new file).
-//   ADR_TEMPLATE=...adr-template.md — points adr-new at this skill's template
-//     instead of adr-tools' own bundled default.
-//
-// Uses PreToolUse's `updatedInput` (not just allow/deny) to rewrite the
-// command before it runs. Only fills in vars that are missing — an assignment
-// the agent already wrote (any value, even a deliberately different template)
-// is left alone. Silent no-op if all three are already present.
-//
-// Safety: a title that happens to contain the literal text "adr new" could
-// make the matching regex fire inside a quoted string. Guarded by counting
-// quote characters before each match — an odd count means "inside an open
-// string", and that occurrence is left untouched rather than risk corrupting
-// the title.
-
-const fs = require('fs');
-
-const DEFAULTS = [
-  ['ADR_TEMPLATE', '.claude/skills/adr-writer/references/adr-template.md'],
-  ['VISUAL', 'true'],
-  ['EDITOR', 'true'],
-];
-
-// boundary/start, leading whitespace, any existing KEY=value prefix, `adr new`.
-const ADR_NEW_RE = /(^|[;&|\n])([ \t]*)((?:[A-Za-z_][A-Za-z0-9_]*=(?:'[^']*'|"[^"]*"|\S*)[ \t]+)*)(adr[ \t]+new\b)/g;
-
-function existingVars(prefix) {
-  const names = new Set();
-  const re = /([A-Za-z_][A-Za-z0-9_]*)=/g;
-  let m;
-  while ((m = re.exec(prefix))) names.add(m[1]);
-  return names;
-}
-
-function isInsideQuotes(command, index) {
-  const before = command.slice(0, index);
-  const dq = (before.match(/"/g) || []).length;
-  const sq = (before.match(/'/g) || []).length;
-  return dq % 2 === 1 || sq % 2 === 1;
-}
-
-function main() {
-  const payload = JSON.parse(fs.readFileSync(0, 'utf8'));
-  const command = payload?.tool_input?.command || '';
-  if (!/\badr\s+new\b/.test(command)) return;
-
-  let changed = false;
-  const updated = command.replace(ADR_NEW_RE, (whole, boundary, ws, existingPrefix, adrNew, offset) => {
-    if (isInsideQuotes(command, offset)) return whole;
-    const present = existingVars(existingPrefix);
-    const missing = DEFAULTS.filter(([name]) => !present.has(name));
-    if (missing.length === 0) return whole;
-    changed = true;
-    const injected = missing.map(([name, value]) => `${name}=${value}`).join(' ');
-    return `${boundary}${ws}${injected} ${existingPrefix}${adrNew}`;
-  });
-  if (!changed) return;
-
-  process.stdout.write(
-    JSON.stringify({
-      systemMessage: 'Added missing VISUAL/EDITOR/ADR_TEMPLATE env vars before `adr new`.',
-      hookSpecificOutput: {
-        hookEventName: 'PreToolUse',
-        permissionDecision: 'allow',
-        updatedInput: { command: updated },
-      },
-    })
-  );
-}
-
-try {
-  main();
-} catch {
-  /* fail open: leave the command untouched */
-}
-process.exit(0);
+#!/usr/bin/env node
+// PreToolUse guard: inject the env vars every `adr new` call needs, so the
+// agent can write a bare `adr new -- "Title"` and get a correct command.
+//
+//   VISUAL=true EDITOR=true  — without them an ambient EDITOR opens an
+//     interactive editor and hangs the session (adr-new always shells out to
+//     $VISUAL/$EDITOR to "edit" the new file).
+//   ADR_TEMPLATE=...adr-template.md — points adr-new at this skill's template
+//     instead of adr-tools' own bundled default.
+//
+// Uses PreToolUse's `updatedInput` (not just allow/deny) to rewrite the
+// command before it runs. Only fills in vars that are missing — an assignment
+// the agent already wrote (any value, even a deliberately different template)
+// is left alone. Silent no-op if all three are already present.
+//
+// Safety: a title that happens to contain the literal text "adr new" could
+// make the matching regex fire inside a quoted string. Guarded by counting
+// quote characters before each match — an odd count means "inside an open
+// string", and that occurrence is left untouched rather than risk corrupting
+// the title.
+
+const fs = require('fs');
+const {
+  invocationRe,
+  isInsideQuotes,
+  isInsideHeredoc,
+  invokesAdr,
+} = require('./lib/adr/command-scan.cjs');
+
+const DEFAULTS = [
+  ['ADR_TEMPLATE', '.claude/skills/adr-writer/references/adr-template.md'],
+  ['VISUAL', 'true'],
+  ['EDITOR', 'true'],
+];
+
+function existingVars(prefix) {
+  const names = new Set();
+  const re = /([A-Za-z_][A-Za-z0-9_]*)=/g;
+  let m;
+  while ((m = re.exec(prefix))) names.add(m[1]);
+  return names;
+}
+
+function main() {
+  const payload = JSON.parse(fs.readFileSync(0, 'utf8'));
+  const command = payload?.tool_input?.command || '';
+  if (!invokesAdr(command, 'new')) return;
+
+  let changed = false;
+  const updated = command.replace(invocationRe('new'), (whole, boundary, ws, existingPrefix, adrNew, offset) => {
+    // Both guards, for the same reason the deny hooks use them: a heredoc body
+    // is documentation being written, and injecting env vars into it would
+    // rewrite the file's contents rather than the command.
+    // `offset` is the boundary character; step past it to the word `adr`.
+    const at = offset + boundary.length + ws.length + existingPrefix.length;
+    if (isInsideQuotes(command, at) || isInsideHeredoc(command, at)) return whole;
+    const present = existingVars(existingPrefix);
+    const missing = DEFAULTS.filter(([name]) => !present.has(name));
+    if (missing.length === 0) return whole;
+    changed = true;
+    const injected = missing.map(([name, value]) => `${name}=${value}`).join(' ');
+    return `${boundary}${ws}${injected} ${existingPrefix}${adrNew}`;
+  });
+  if (!changed) return;
+
+  process.stdout.write(
+    JSON.stringify({
+      systemMessage: 'Added missing VISUAL/EDITOR/ADR_TEMPLATE env vars before `adr new`.',
+      hookSpecificOutput: {
+        hookEventName: 'PreToolUse',
+        permissionDecision: 'allow',
+        updatedInput: { command: updated },
+      },
+    })
+  );
+}
+
+try {
+  main();
+} catch {
+  /* fail open: leave the command untouched */
+}
+process.exit(0);

package/template/.claude/hooks/lib/adr/command-scan.cjs

@@ -0,0 +1,107 @@
+'use strict';
+
+// Tells a real `adr` invocation apart from a command that merely mentions one.
+//
+// Three PreToolUse hooks key off `adr new` and `adr init`. Matching those words
+// anywhere in the command string is too loose: a commit message explaining ADR
+// work, a grep for the phrase, or a heredoc of documentation all contain them
+// and none of them run the tool. Denying those commands leaves the user staring
+// at an error about a command they never wrote.
+//
+// Three tests must all pass before an occurrence counts:
+//
+//   1. It sits at a command position — the start of the string, or just after a
+//      separator such as `;` `&&` `||` `|` `(` or a newline — allowing for any
+//      KEY=value assignments in front of it.
+//   2. It is not inside an open quote.
+//   3. It is not inside a heredoc body, which is data being written rather than
+//      a command being run.
+//
+// Where the two disagree with each other, the answer is "not an invocation".
+// A missed invocation makes a hook skip work the user will notice at once; a
+// false one blocks an unrelated command for a reason nobody can guess.
+
+// boundary/start, whitespace, any existing KEY=value prefix, then `adr <sub>`.
+function invocationRe(sub) {
+  return new RegExp(
+    `(^|[;&|\\n(){}])([ \\t]*)((?:[A-Za-z_][A-Za-z0-9_]*=(?:'[^']*'|"[^"]*"|\\S*)[ \\t]+)*)(adr[ \\t]+${sub}\\b)`,
+    'g'
+  );
+}
+
+// An odd number of quote characters before this point means the point is inside
+// a string that is still open.
+function isInsideQuotes(command, index) {
+  const before = command.slice(0, index);
+  const dq = (before.match(/"/g) || []).length;
+  const sq = (before.match(/'/g) || []).length;
+  return dq % 2 === 1 || sq % 2 === 1;
+}
+
+const escapeRe = (s) => s.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+
+// `<<TAG`, `<<-TAG`, `<<'TAG'`, `<<"TAG"`. `<<<` is a herestring, not a heredoc,
+// and does not match here because `<` is neither a quote nor a word character.
+const HEREDOC_OPEN = /<<(-?)[ \t]*(?:'([^']+)'|"([^"]+)"|([A-Za-z_][A-Za-z0-9_]*))/g;
+
+// Offset ranges covering heredoc bodies.
+//
+// A heredoc body is data being written, not commands being run. Writing install
+// docs that show `adr new -- "Use X"` is an ordinary thing to do in this repo,
+// and the line sits at the start of its own line with balanced quotes in front
+// of it, so both of the other tests would wave it through.
+//
+// Known limit: several heredocs opened on one line share the first body start,
+// so the ranges merge. That errs toward treating more text as data, which only
+// ever makes this scanner quieter.
+function heredocRanges(command) {
+  const ranges = [];
+  const re = new RegExp(HEREDOC_OPEN.source, 'g');
+  let m;
+
+  while ((m = re.exec(command))) {
+    const tag = m[2] || m[3] || m[4];
+    const newline = command.indexOf('\n', m.index);
+    if (newline === -1) continue; // an opener with no body on this command
+
+    const start = newline + 1;
+    // `<<-` lets the terminator be indented with tabs.
+    const terminator = new RegExp(`^${m[1] === '-' ? '[ \\t]*' : ''}${escapeRe(tag)}[ \\t]*$`, 'm');
+    const hit = command.slice(start).match(terminator);
+    ranges.push([start, hit ? start + hit.index : command.length]);
+  }
+
+  return ranges;
+}
+
+function isInsideHeredoc(command, index) {
+  return heredocRanges(command).some(([start, end]) => index >= start && index < end);
+}
+
+// Where the word `adr` itself starts. The match begins at the boundary
+// character before it, which is close enough for counting quotes but one
+// position short of the heredoc body it may sit in.
+function adrOffsetOf(match) {
+  return match.index + match[1].length + match[2].length + match[3].length;
+}
+
+// True when the command really runs `adr <sub>` at least once.
+function invokesAdr(command, sub) {
+  const re = invocationRe(sub);
+  const bodies = heredocRanges(command);
+  const inBody = (i) => bodies.some(([start, end]) => i >= start && i < end);
+  let m;
+  while ((m = re.exec(command))) {
+    const at = adrOffsetOf(m);
+    if (!isInsideQuotes(command, at) && !inBody(at)) return true;
+  }
+  return false;
+}
+
+module.exports = {
+  invokesAdr,
+  isInsideQuotes,
+  isInsideHeredoc,
+  heredocRanges,
+  invocationRe,
+};