Skip to content

code-yeongyu/codex-comment-checker

Repository files navigation

codex-comment-checker

ci license: MIT

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

Behavior

Case Result
apply_patch succeeds parses tool_input.command and checks added/updated files
write, edit, multi_edit, or multiedit succeeds maps the Codex payload to the native checker hook input
non-edit tool succeeds ignored
checker exits 2 returns Codex PostToolUse blocking feedback so the model fixes or explains the warning
checker binary missing or unavailable on the current platform emits no hook output
checker exits unexpectedly leaves 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:

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

No MCP server or comment_check tool is exposed.

Local Development

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

Smoke-test the hook:

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

Local Codex Installation

From the marketplace root containing this plugin:

codex plugin marketplace add /path/to/codex-plugins
node /path/to/codex-plugins/scripts/install-local.mjs /path/to/codex-plugins

If your local Codex build exposes plugin install commands, you can install from the UI or CLI instead. For older local builds, the marketplace installer builds and copies the plugin into ~/.codex/plugins/cache/<marketplace>/codex-comment-checker/0.1.1, installs runtime dependencies there, and enables:

[features]
plugins = true
plugin_hooks = true

[plugins."codex-comment-checker@code-yeongyu-codex-plugins"]
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.

Related

About

Codex plugin that runs comment-checker automatically after apply_patch edits.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors