21d2bd039d
* fix(hooks): skip read-guard advisory on Claude Code runtime (#1984) Claude Code natively enforces read-before-edit at the runtime level, so the gsd-read-guard.js advisory is redundant — it wastes ~80 tokens per Write/Edit call and clutters tool flow with system-reminder noise. Add early exit when CLAUDE_SESSION_ID is set (standard Claude Code session env var). Non-Claude runtimes (OpenCode, Gemini, etc.) that lack native read-before-edit enforcement continue to receive the advisory as before. Closes #1984 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix(hooks): sanitize runHook env to prevent test failures in Claude Code The runHook() test helper now blanks CLAUDE_SESSION_ID so positive-path tests pass even when the test suite runs inside a Claude Code session. The new skip test passes the env var explicitly via envOverrides. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
83 lines
2.8 KiB
JavaScript
83 lines
2.8 KiB
JavaScript
#!/usr/bin/env node
|
|
// gsd-hook-version: {{GSD_VERSION}}
|
|
// GSD Read Guard — PreToolUse hook
|
|
// Injects advisory guidance when Write/Edit targets an existing file,
|
|
// reminding the model to Read the file first.
|
|
//
|
|
// Background: Non-Claude models (e.g. MiniMax M2.5 on OpenCode) don't
|
|
// natively follow the read-before-edit pattern. When they attempt to
|
|
// Write/Edit an existing file without reading it, the runtime rejects
|
|
// with "You must read file before overwriting it." The model retries
|
|
// without reading, creating an infinite loop that burns through usage.
|
|
//
|
|
// This hook prevents that loop by injecting clear guidance BEFORE the
|
|
// tool call reaches the runtime. The model sees the advisory and can
|
|
// issue a Read call on the next turn.
|
|
//
|
|
// Triggers on: Write and Edit tool calls
|
|
// Action: Advisory (does not block) — injects read-first guidance
|
|
// Only fires when the target file already exists on disk.
|
|
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
|
|
let input = '';
|
|
const stdinTimeout = setTimeout(() => process.exit(0), 3000);
|
|
process.stdin.setEncoding('utf8');
|
|
process.stdin.on('data', chunk => input += chunk);
|
|
process.stdin.on('end', () => {
|
|
clearTimeout(stdinTimeout);
|
|
try {
|
|
const data = JSON.parse(input);
|
|
const toolName = data.tool_name;
|
|
|
|
// Only intercept Write and Edit tool calls
|
|
if (toolName !== 'Write' && toolName !== 'Edit') {
|
|
process.exit(0);
|
|
}
|
|
|
|
// Claude Code natively enforces read-before-edit — skip the advisory (#1984)
|
|
if (process.env.CLAUDE_SESSION_ID) {
|
|
process.exit(0);
|
|
}
|
|
|
|
const filePath = data.tool_input?.file_path || '';
|
|
if (!filePath) {
|
|
process.exit(0);
|
|
}
|
|
|
|
// Only inject guidance when the file already exists.
|
|
// New files don't need a prior Read — the runtime allows creating them directly.
|
|
let fileExists = false;
|
|
try {
|
|
fs.accessSync(filePath, fs.constants.F_OK);
|
|
fileExists = true;
|
|
} catch {
|
|
// File does not exist — no guidance needed
|
|
}
|
|
|
|
if (!fileExists) {
|
|
process.exit(0);
|
|
}
|
|
|
|
const fileName = path.basename(filePath);
|
|
|
|
// Advisory guidance — does not block the operation
|
|
const output = {
|
|
hookSpecificOutput: {
|
|
hookEventName: 'PreToolUse',
|
|
additionalContext:
|
|
`READ-BEFORE-EDIT REMINDER: You are about to modify "${fileName}" which already exists. ` +
|
|
'If you have not already used the Read tool to read this file in the current session, ' +
|
|
'you MUST Read it first before editing. The runtime will reject edits to files that ' +
|
|
'have not been read. Use the Read tool on this file path, then retry your edit.',
|
|
},
|
|
};
|
|
|
|
process.stdout.write(JSON.stringify(output));
|
|
} catch {
|
|
// Silent fail — never block tool execution
|
|
process.exit(0);
|
|
}
|
|
});
|