Files

T

YeonGyu-Kim 9f6d0d2281 docs(agents-md): refresh hierarchical knowledge base for v4.1.2

- Bump root AGENTS.md header: 2026-05-14 → 2026-05-15, commit 5ffbe0e24 → 53a740636, release v4.1.1 → v4.1.2
- Update file counts: 2034 (1337+697) → 2041 (1340+701), LOC ~292k → ~294k
- Fix STRUCTURE: openclaw lives at src/openclaw/ (not src/features/); list more accurate feature modules in the parenthetical
- Clarify interactive_bash gate: tmux binary on PATH via isInteractiveBashEnabled() (not 'tmux enabled')
- Fix docs/reference/features.md hook counts: Tool Guard 14→16, Total base 52→54, total with team-mode 59→61
- Bump 'Generated' date on all 43 subdir AGENTS.md files to 2026-05-15
- Preserve promptAsync injection cautions verbatim (per request)

2026-05-15 13:48:11 +09:00

2.0 KiB

Raw Blame History

src/hooks/comment-checker/ — AI Slop Comment Blocker

Generated: 2026-05-15

OVERVIEW

Tool Guard tier hook. Runs after write/edit tools to detect AI-generated comment patterns in code and block them before they land. Backed by @code-yeongyu/comment-checker binary (trusted dependency).

WHAT IT BLOCKS

AI slop comment smells:

Restating what code literally does (// increment counter)
Filler phrases (// obviously, // clearly, // simply)
Decorative separators without purpose
JSDoc on trivially-named functions
// TODO: without context
Comments contradicting surrounding code

See @code-yeongyu/comment-checker for the authoritative blocklist.

EXECUTION FLOW

tool.execute.after (write | edit | hashline edit)
  → extract changed lines from tool output
  → spawn comment-checker binary with changed file path
  → parse findings (line ranges + violation category)
  → if findings → inject tool-level error → agent must fix

KEY FILES

File	Purpose
`hook.ts`	`createCommentCheckerHook()` — main factory, tool.execute.after handler
`comment-checker-runner.ts`	Spawn binary, parse JSON output
`changed-line-extractor.ts`	Extract which lines changed from tool result
`findings-formatter.ts`	Format violations as actionable error message
`binary-resolver.ts`	Locate `comment-checker` binary (node_modules + PATH)

CONFIG

// oh-my-opencode.jsonc
{
  "comment_checker": {
    "enabled": true,      // default: true
    "severity": "error"   // error blocks, warning notifies only
  }
}

Disable via "disabled_hooks": ["comment-checker"].

BYPASS FOR LEGITIMATE COMMENTS

Prefix with // @allow or mark file scope with // comment-checker-disable-file at top. Use sparingly — defeating the purpose.

Doctor check: src/cli/doctor/checks/tools.ts verifies comment-checker binary availability
Postinstall: postinstall.mjs downloads binary if missing

2.0 KiB Raw Blame History