Skip to content

Organize CLI argument groups for better structure and clarity #365

Merged
shenxianpeng merged 2 commits intomainfrom
fix/group-by-args
Feb 2, 2026
Merged

Organize CLI argument groups for better structure and clarity #365
shenxianpeng merged 2 commits intomainfrom
fix/group-by-args

Conversation

@shenxianpeng
Copy link
Member

@shenxianpeng shenxianpeng commented Feb 2, 2026 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • New Features
    • Added "organize" and "orchestrate" as new commit check keywords.
    • Improved CLI help text formatting and argument organization for better readability.

@shenxianpeng shenxianpeng requested a review from a team as a code owner February 2, 2026 23:15
@netlify
Copy link

netlify bot commented Feb 2, 2026 •
edited
Loading

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 81370d2
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/698130007fe9530007878be6
😎 Deploy Preview https://deploy-preview-365--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added the bug Something isn't working label Feb 2, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Feb 2, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

The PR adds two new imperative verbs ("organize" and "orchestrate") to the IMPERATIVES set, and reorganizes the CLI argument parser into grouped sections for improved help text formatting without altering command-line behavior.

Changes

Cohort / File(s) Summary
IMPERATIVES Expansion
commit_check/imperatives.py		 Added "organize" and "orchestrate" verbs to the IMPERATIVES set after "output".
CLI Argument Reorganization
commit_check/main.py		 Restructured ArgumentParser to use RawDescriptionHelpFormatter and grouped related arguments (check_type, commit_message_options, branch_options) with minor help text refinements; no changes to command-line semantics.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested labels

documentation

Poem

🐰 Organize and orchestrate, the imperatives now gleam,
With grouped arguments flowing like a well-structured scheme,
The CLI breathes cleaner, help text shines so bright,
New verbs hop into place—what a delightful sight!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change in the PR: reorganizing CLI arguments into grouped sections for better structure.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/group-by-args

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud
Copy link

sonarqubecloud bot commented Feb 2, 2026

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@codecov
Copy link

codecov bot commented Feb 2, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.37%. Comparing base (ecd99cb) to head (81370d2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #365      +/-   ##
==========================================
+ Coverage   94.35%   94.37%   +0.02%     
==========================================
  Files           9        9              
  Lines         797      800       +3     
==========================================
+ Hits          752      755       +3     
  Misses         45       45

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@codspeed-hq
Copy link

codspeed-hq bot commented Feb 2, 2026

Merging this PR will degrade performance by 30.73%

⚡ 23 improved benchmarks
❌ 1 regressed benchmark
✅ 141 untouched benchmarks
⏩ 108 skipped benchmarks1

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Performance Changes

Benchmark BASE HEAD Efficiency
⚡ test_cli_allow_merge_commits_false 5.1 ms 4.5 ms +13.07%
⚡ test_cli_allow_commit_types 5.1 ms 4.5 ms +13.12%
⚡ test_cli_multiple_args_combined 5.9 ms 5.3 ms +10.51%
⚡ test_env_subject_imperative 5 ms 4.4 ms +13.2%
⚡ test_cli_subject_imperative_true 5 ms 4.4 ms +13.26%
⚡ test_env_overrides_default 5.1 ms 4.5 ms +12.98%
⚡ test_cli_subject_imperative_false 5.5 ms 5 ms +10.42%
⚡ test_cli_subject_max_length 5.1 ms 4.5 ms +12.99%
⚡ test_env_allow_commit_types 5.1 ms 4.5 ms +12.96%
⚡ test_env_subject_max_length 5.1 ms 4.5 ms +12.62%
⚡ test_dry_run_always_passes 3.2 ms 2.6 ms +22.24%
⚡ test_author_email_validation 3.6 ms 3 ms +19.47%
⚡ test_cli_overrides_env 5.6 ms 5 ms +10.99%
⚡ test_author_name_validation 3.6 ms 3 ms +19.74%
⚡ test_branch_validation 3.8 ms 3.2 ms +18.88%
⚡ test_message_validation_with_invalid_commit 5.1 ms 4.5 ms +12.84%
⚡ test_message_validation_with_valid_commit 5.8 ms 5.2 ms +10.85%
⚡ test_main_with_dry_run_all_checks 3.8 ms 3.2 ms +18.08%
⚡ test_version 2 ms 1.3 ms +47.99%
⚡ test_main_with_invalid_config_file 3.2 ms 2.7 ms +22.3%
... ... ... ... ...

ℹ️ Only the first 20 benchmarks are displayed. Go to the app to view all benchmarks.

Comparing fix/group-by-args (81370d2) with main (450e718)2

Open in CodSpeed

Footnotes

  1. 108 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports. ↩

  2. No successful run was found on main (ecd99cb) during the generation of this report, so 450e718 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

@shenxianpeng shenxianpeng added enhancement New feature or request and removed bug Something isn't working labels Feb 2, 2026
@shenxianpeng shenxianpeng merged commit bd1abc3 into main Feb 2, 2026
35 of 36 checks passed
@shenxianpeng shenxianpeng deleted the fix/group-by-args branch February 2, 2026 23:46
@coderabbitai coderabbitai bot mentioned this pull request Feb 3, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

enhancement New feature or request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@shenxianpeng