mirror of
https://github.com/affaan-m/everything-claude-code.git
synced 2026-03-30 13:43:26 +08:00
3c3781ca43
- Add options={} parameter to run() to match run-with-flags.js contract
- Remove case-insensitive flag from extension pre-filter for consistency
with ADHOC_FILENAMES regex (both now case-sensitive)
- Expand warning text to list more structured paths
- Add test cases for uppercase extensions (TODO.MD, NOTES.TXT)
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signed-off-by: Lidang-Jiang <lidangjiang@gmail.com>
91 lines
2.6 KiB
JavaScript
91 lines
2.6 KiB
JavaScript
#!/usr/bin/env node
|
|
/**
|
|
* Doc file warning hook (PreToolUse - Write)
|
|
*
|
|
* Uses a denylist approach: only warn on known ad-hoc documentation
|
|
* filenames (NOTES, TODO, SCRATCH, etc.) outside structured directories.
|
|
* This avoids false positives for legitimate markdown-heavy workflows
|
|
* (specs, ADRs, command definitions, skill files, etc.).
|
|
*
|
|
* Policy ported from the intent of PR #962 into the current hook architecture.
|
|
* Exit code 0 always (warns only, never blocks).
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const path = require('path');
|
|
|
|
const MAX_STDIN = 1024 * 1024;
|
|
let data = '';
|
|
|
|
// Known ad-hoc filenames that indicate impulse/scratch files (case-sensitive, uppercase only)
|
|
const ADHOC_FILENAMES = /^(NOTES|TODO|SCRATCH|TEMP|DRAFT|BRAINSTORM|SPIKE|DEBUG|WIP)\.(md|txt)$/;
|
|
|
|
// Structured directories where even ad-hoc names are intentional
|
|
const STRUCTURED_DIRS = /(^|\/)(docs|\.claude|\.github|commands|skills|benchmarks|templates|\.history|memory)\//;
|
|
|
|
function isSuspiciousDocPath(filePath) {
|
|
const normalized = filePath.replace(/\\/g, '/');
|
|
const basename = path.basename(normalized);
|
|
|
|
// Only inspect .md and .txt files (case-sensitive, consistent with ADHOC_FILENAMES)
|
|
if (!/\.(md|txt)$/.test(basename)) return false;
|
|
|
|
// Only flag known ad-hoc filenames
|
|
if (!ADHOC_FILENAMES.test(basename)) return false;
|
|
|
|
// Allow ad-hoc names inside structured directories (intentional usage)
|
|
if (STRUCTURED_DIRS.test(normalized)) return false;
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Exportable run() for in-process execution via run-with-flags.js.
|
|
* Avoids the ~50-100ms spawnSync overhead when available.
|
|
*/
|
|
function run(inputOrRaw, options = {}) {
|
|
let input;
|
|
try {
|
|
input = typeof inputOrRaw === 'string'
|
|
? (inputOrRaw.trim() ? JSON.parse(inputOrRaw) : {})
|
|
: (inputOrRaw || {});
|
|
} catch {
|
|
return { exitCode: 0 };
|
|
}
|
|
const filePath = String(input?.tool_input?.file_path || '');
|
|
|
|
if (filePath && isSuspiciousDocPath(filePath)) {
|
|
return {
|
|
exitCode: 0,
|
|
stderr:
|
|
'[Hook] WARNING: Ad-hoc documentation filename detected\n' +
|
|
`[Hook] File: ${filePath}\n` +
|
|
'[Hook] Consider using a structured path (e.g. docs/, .claude/, skills/, .github/, benchmarks/, templates/)',
|
|
};
|
|
}
|
|
|
|
return { exitCode: 0 };
|
|
}
|
|
|
|
module.exports = { run };
|
|
|
|
// Stdin fallback for spawnSync execution
|
|
process.stdin.setEncoding('utf8');
|
|
process.stdin.on('data', c => {
|
|
if (data.length < MAX_STDIN) {
|
|
const remaining = MAX_STDIN - data.length;
|
|
data += c.substring(0, remaining);
|
|
}
|
|
});
|
|
|
|
process.stdin.on('end', () => {
|
|
const result = run(data);
|
|
|
|
if (result.stderr) {
|
|
process.stderr.write(result.stderr + '\n');
|
|
}
|
|
|
|
process.stdout.write(data);
|
|
});
|