https://github.com/code-yeongyu/codex-comment-checker
Codex plugin that runs comment-checker automatically after apply_patch edits.
https://github.com/code-yeongyu/codex-comment-checker
apply-patch codex codex-plugin comment-checker hooks typescript
Last synced: 9 days ago
JSON representation
Codex plugin that runs comment-checker automatically after apply_patch edits.
- Host: GitHub
- URL: https://github.com/code-yeongyu/codex-comment-checker
- Owner: code-yeongyu
- License: mit
- Created: 2026-05-15T04:46:39.000Z (15 days ago)
- Default Branch: main
- Last Pushed: 2026-05-15T08:39:43.000Z (15 days ago)
- Last Synced: 2026-05-15T09:25:59.580Z (15 days ago)
- Topics: apply-patch, codex, codex-plugin, comment-checker, hooks, typescript
- Language: TypeScript
- Size: 43.9 KB
- Stars: 2
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Notice: NOTICE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# codex-comment-checker
[](https://github.com/code-yeongyu/codex-comment-checker/actions/workflows/ci.yml) [](LICENSE)
Codex plugin that runs [`@code-yeongyu/comment-checker`](https://github.com/code-yeongyu/go-claude-code-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:
```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
From the marketplace root containing this plugin:
```bash
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//codex-comment-checker/0.1.1`, installs runtime dependencies there, and enables:
```toml
[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`.
- 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](LICENSE).
## Related
- [pi-comment-checker](https://github.com/code-yeongyu/pi-comment-checker) - source extension this Codex plugin ports.
- [comment-checker](https://github.com/code-yeongyu/go-claude-code-comment-checker) - native checker binary.