Repository navigation
feat: replace the ASCII banner with a one-line failure header - #682
Conversation
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 37 minutes. View limit details
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #682 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 14 14
Lines 2519 2529 +10
Branches 488 491 +3
=========================================
+ Hits 2519 2529 +10 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
A failure now opens with one line naming what was rejected and how many checks failed, then lists each failure under a marker, with its explanation, suggestion and docs link indented beneath it. A commit message shown as the failing value is cut to its subject, with a count of the lines left out. JSON and --compact output are unchanged.
cbe1be9 to
e17aae5
Compare
* docs: re-record the demo GIF to show the key checks The demo now opens on a project's cchk.toml and one commit that breaks it three ways: a non-conventional message, an AI co-author trailer and a non-conventional branch name. It then shows the commit-msg hook fixing a mechanical slip on its own and the commit going through. * docs: add before/after screenshot for review * docs: drop the review screenshot --------- Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>
|
Merging this PR will improve performance by 28.59%1 warning
Performance Changes
Tip Curious why performance improved? Comment Comparing Footnotes
|



What
The failure report in text mode gets a cleaner layout, and the README demo GIF is re-recorded with it (#683 was merged into this branch).
✖ Commit rejected by Commit Check · 3 checks failed(names Branch / Tag / Push like before, with a count).✖marker (▲for awarnrule):✖ CC001 message failed: <value>, in place ofCC001 message check failed ==> <value>.Suggest:andDocs:are indented under it;Suggest:is bold green,Docs:is dimmed.(+N more line), so trailers no longer appear in red between the value and the explanation.x/!when stdout cannot encode the symbols (legacy Windows code pages).assets/demo.gif+assets/demo.tape:cchk.toml, one commit rejected for message (CC001), AI co-author (CC013) and branch (CC201), then--fixcorrectingFeat add login pageand the commit passing.Unchanged:
--format json,--compact, exit codes,--no-banner(now hides the header line),NO_COLOR/FORCE_COLOR, hyperlink handling. The Action and the App read JSON, so their output is not affected.Before / after
Output,
commit-check -m msg -b --ai-attribution forbidwith a messageAdd login page+ aCo-authored-by: Claudetrailer, on branchuser-login:Demo GIF, first frame:
Follow-up
The text samples on commit-check.com (getting-started, troubleshoot, landing terminal) show the old format; they need a small update once this ships in a release.