chore(lint): clear remaining code-comments debt in feature files (residue of #53) #68

New issue

Closed

opened 2026-06-04 10:19:19 +00:00 by coilysiren · 2 comments

coilysiren commented

2026-06-04 10:19:19 +00:00

Owner

The code-comments pre-commit hook (always_run, pass_filenames: false,
whole-repo) currently reports 65 violations across five feature files,
all 3+ line contiguous comment blocks over the 2-line cap. A normal
git commit is blocked by these until they are cleared.

This is the residue of #53. When #53 was filed only dispatch.go and
sudo.go failed (now fixed in 9128157). The remaining debt was
introduced by later feature commits and was deliberately kept out of the
#53 chore to avoid scope-creep into in-flight feature work.

Violation counts by file (pre-commit run code-comments --all-files):

hookcfg/hookcfg.go - 16
allowlist/allowlist.go - 14
repocfg/security.go - 13
cmd/cli-guard-hook/main.go - 13
hook/hook.go - 9

These are security-relevant files (repocfg/security.go, hookcfg.go),
so the comment trims deserve a real pass that preserves the documentation
intent rather than a mechanical truncation. Move longer explanations to
docs/ where a comment block is genuinely load-bearing.

Done when pre-commit run code-comments --all-files is green.

The `code-comments` pre-commit hook (`always_run`, `pass_filenames: false`, whole-repo) currently reports **65 violations** across five feature files, all 3+ line contiguous comment blocks over the 2-line cap. A normal `git commit` is blocked by these until they are cleared. This is the residue of #53. When #53 was filed only `dispatch.go` and `sudo.go` failed (now fixed in `9128157`). The remaining debt was introduced by later feature commits and was deliberately kept out of the #53 chore to avoid scope-creep into in-flight feature work. Violation counts by file (`pre-commit run code-comments --all-files`): - `hookcfg/hookcfg.go` - 16 - `allowlist/allowlist.go` - 14 - `repocfg/security.go` - 13 - `cmd/cli-guard-hook/main.go` - 13 - `hook/hook.go` - 9 These are security-relevant files (`repocfg/security.go`, `hookcfg.go`), so the comment trims deserve a real pass that preserves the documentation intent rather than a mechanical truncation. Move longer explanations to `docs/` where a comment block is genuinely load-bearing. Done when `pre-commit run code-comments --all-files` is green.

coilysiren added this to the sunday-sprint milestone

2026-06-05 03:41:16 +00:00

coilysiren added the

sunday-sprint

label

2026-06-05 03:41:16 +00:00

coilysiren added the

label

2026-06-06 04:26:58 +00:00

coilysiren added

and removed

labels

2026-06-17 08:39:58 +00:00

coilysiren added the

headless

label

2026-06-18 06:17:51 +00:00

coilysiren commented

2026-06-18 07:30:31 +00:00

Author

Owner

🔒 Reserved by ward agent claude — container ward-cli-guard-issue-68-claude-6a467a66 on host kais-macbook-pro.local is carrying this issue (reserved 2026-06-18T07:30:30Z). Concurrent ward agent runs are blocked until it finishes or the reservation goes stale (2h0m0s TTL); --force overrides.

— Claude (she/her), via ward agent

🔒 Reserved by `ward agent claude` — container `ward-cli-guard-issue-68-claude-6a467a66` on host `kais-macbook-pro.local` is carrying this issue (reserved 2026-06-18T07:30:30Z). Concurrent `ward agent` runs are blocked until it finishes or the reservation goes stale (2h0m0s TTL); `--force` overrides.  — Claude (she/her), via `ward agent`

coilysiren commented

2026-06-18 07:33:23 +00:00

Author

Owner

Already resolved on main — no code change required.

The five files named here no longer carry comment-discipline debt:

The four feature files (hookcfg/hookcfg.go, allowlist/allowlist.go, repocfg/security.go, hook/hook.go) were relocated under cli/ by 5d09088 (refactor!: reorganize package tree around the three guarded surfaces) — successors are cli/hookcfg/hookcfg.go, cli/allowlist/allowlist.go, cli/repocfg/security.go, cli/hook/hook.go.
The remaining comment-discipline violations were cleaned by 71a8b94 (chore(code-comments): clean comment-discipline violations).

Both commits are already on origin/main. Verification of the success criterion against current main:

$ pre-commit run code-comments --all-files
code comment discipline..................................................Passed

Per-successor-file scan (named files + every current *hook*.go) reports 0 violations each. The debt from #53 is gone, so there is nothing left to implement, commit, or merge. Closing.

Already resolved on `main` — no code change required. The five files named here no longer carry comment-discipline debt: - The four feature files (`hookcfg/hookcfg.go`, `allowlist/allowlist.go`, `repocfg/security.go`, `hook/hook.go`) were relocated under `cli/` by `5d09088` (*refactor!: reorganize package tree around the three guarded surfaces*) — successors are `cli/hookcfg/hookcfg.go`, `cli/allowlist/allowlist.go`, `cli/repocfg/security.go`, `cli/hook/hook.go`. - The remaining comment-discipline violations were cleaned by `71a8b94` (*chore(code-comments): clean comment-discipline violations*). Both commits are already on `origin/main`. Verification of the success criterion against current `main`: ``` $ pre-commit run code-comments --all-files code comment discipline..................................................Passed ``` Per-successor-file scan (named files + every current `*hook*.go`) reports 0 violations each. The debt from #53 is gone, so there is nothing left to implement, commit, or merge. Closing.

coilysiren closed this issue

2026-06-18 07:33:28 +00:00