Back to Oh My Openagent

codex-comment-checker

packages/omo-codex/plugin/components/comment-checker/README.md

4.5.122.7 KB
Original Source

codex-comment-checker

Codex plugin that runs @code-yeongyu/comment-checker after successful edit-like PostToolUse hook calls.

Behavior

CaseResult
apply_patch succeedsparses tool_input.command and checks added/updated files
write, edit, multi_edit, or multiedit succeedsmaps the Codex payload to the native checker hook input
non-edit tool succeedsignored
checker exits 2returns Codex PostToolUse blocking feedback so the model fixes or explains the warning
checker binary missing or unavailable on the current platformemits no hook output
checker exits unexpectedlyleaves hook output unchanged

Deletes are ignored because they cannot introduce new comments.

Codex Plugin

The plugin ships:

  • .codex-plugin/plugin.json for Codex plugin discovery.
  • hooks/hooks.json for the PostToolUse hook.
  • skills/comment-checker/SKILL.md with usage guidance.

The hook command is:

bash
node "${PLUGIN_ROOT}/dist/cli.js" hook post-tool-use

No MCP server or comment_check tool is exposed.

Local Development

bash
npm install
npm test
npm run typecheck
npm run check
npm pack --dry-run

Smoke-test the hook:

bash
node dist/cli.js hook post-tool-use < test/fixtures/post-tool-use.json

Local Codex Installation

bash
bunx lazycodex install

The installer builds and copies the plugin into ~/.codex/plugins/cache/sisyphuslabs/omo/0.1.0, registers the sisyphuslabs marketplace from the lazycodex Git repository, installs runtime dependencies there, and enables:

toml
[features]
plugins = true
plugin_hooks = true

[plugins."omo@sisyphuslabs"]
enabled = true

Branch Rules and Releases

  • main is protected by .github/branch-ruleset.json.
  • CI runs Node 20 and 22 on Ubuntu, macOS, and Windows.
  • Releases are GitHub Releases tagged as v<semver>.
  • Publishing runs from the publish workflow after a GitHub Release is published.

Privacy

This plugin runs locally. It sends hook input to the optional local comment-checker binary when available and does not call a network service by itself.

License

MIT.