feat: help compliance for all 12 dispatchers + automated checker #328
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Spec for fixing all 12 dispatcher help functions to match CONVENTIONS.md standards, plus automated compliance checker (shared library + test suite + flow doctor integration). Audit found 6/12 non-compliant dispatchers (2 grade F, 1 grade C, 3 grade B). Checker will enforce 9 rules via CI and on-demand CLI. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Fix 6 non-compliant help functions against CONVENTIONS.md:173-199: - obs: full rewrite, rename obs_help→_obs_help, add colors/sections (F→A) - prompt: rewrite cat<<EOF to echo -e with _C_* colors (F→A) - dot: replace FLOW_COLORS[] with _C_*, restructure sections (C→A) - cc: change ╔═╗ to ╭─╮ box, add standard sections (B-→A) - tm: change ╔═╗ to ╭─╮ box, add emoji markers (B-→A) - teach: cat<<EOF to echo -e, FLOW_COLORS→_C_*, condense sections (B+→A) - v: add missing 📚 See Also section Add automated compliance infrastructure: - lib/help-compliance.zsh: 9-rule shared validation library - tests/test-help-compliance.zsh: 14-test suite (12 dispatchers + 2 meta) - flow doctor --help-check: CLI integration for on-demand validation - Integrated into tests/run-all.sh All 12 dispatchers now pass all 9 compliance rules. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add tests/test-help-compliance-dogfood.zsh (336 tests across 10 sections) - Fix r dispatcher missing --help/-h routing - Fix obs dispatcher --help eaten by global flag pre-parser - Fix v dispatcher missing color fallbacks for standalone use - Add dogfooding test to run-all.sh Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Standardize v dispatcher color fallbacks to global if-block pattern (was local-scoped, inconsistent with other 6 fixed dispatchers) - Expand teach help with full 26-alias shortcuts table and 3 workflow examples (discoverability regression from condensing 149→81 lines) - Migrate doctor --help-check header from FLOW_COLORS[] to _C_* colors - Tighten Rule 6 regex from '💡.*TIP' to '💡 TIP' (avoids Rule 4 overlap) - Add negative compliance test with mock non-compliant dispatcher - Document canonical color fallback pattern in CONVENTIONS.md All tests pass: 14/14 core + 342/342 dogfood (was 336) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- package.json: 6.1.0 → 6.2.0 (sync with release) - mkdocs.yml: remove deprecated tags_file option (Material 9.6+) docs/tags.md already has inline <!-- material/tags --> marker Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Data-Wise
force-pushed
the
feature/help-compliance
branch
from
58d2206 to
3b1aea4
Compare
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
lib/help-compliance.zsh) with 9 validation rulesflow doctor --help-checkCLI integrationr --help/-hmissing,obs --helpeaten by flag pre-parser,vmissing color fallbacksTest plan
tests/test-help-compliance.zsh— 14/14 pass (9 rules × 12 dispatchers)tests/test-help-compliance-dogfood.zsh— 336/336 pass (10 sections)flow doctor --help-check— reports all 12 dispatchers compliant<dispatcher> helpoutputs🤖 Generated with Claude Code