feat: add alias `cchk` for `commit-check` #268

shenxianpeng · 2025-09-03T02:44:29Z

part of #264

Summary by CodeRabbit

New Features
- Added a short CLI alias: cchk (equivalent to commit-check) for a quicker command.
Documentation
- Updated installation/usage instructions to reference both commit-check and cchk and improved formatting for clarity.
Chores
- Bumped pre-commit hook versions to their latest releases to keep tooling up to date.

coderabbitai · 2025-09-03T02:44:35Z

Walkthrough

Bumps several pre-commit hook revisions, adds a new CLI alias cchk pointing to commit_check.main:main, and updates README to mention the alias.

Changes

Cohort / File(s)	Summary
Tooling / pre-commit `\.pre-commit-config.yaml`	Updated hook revisions: `pre-commit-hooks` v5.0.0 → v6.0.0, `astral-sh/ruff-pre-commit` v0.12.2 → v0.12.11, `pre-commit/mirrors-mypy` v1.16.1 → v1.17.1, `commit-check/commit-check` v0.9.8 → v0.10.2.
CLI entrypoints & docs `pyproject.toml`, `README.rst`	Added console script alias `cchk = "commit_check.main:main"` alongside existing `commit-check`; README updated to mention both `commit-check --help` and `cchk --help` with minor formatting change.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor User
  participant Shell as Shell
  participant Entry as CLI Entrypoint
  participant Main as commit_check.main:main

  rect rgba(220,235,245,0.5)
    note right of User: Primary entrypoint
    User->>Shell: run "commit-check …"
    Shell->>Entry: launch `commit-check`
    Entry->>Main: invoke main(args)
    Main-->>User: output / exit
  end

  rect rgba(230,245,230,0.5)
    note right of User: New alias
    User->>Shell: run "cchk …"
    Shell->>Entry: launch `cchk` (alias)
    Entry->>Main: invoke main(args)
    Main-->>User: output / exit
  end

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

chore: update .pre-commit-config.yaml #198 — Also updates .pre-commit-config.yaml and bumps the commit-check hook revision; closely related maintenance change.

Poem

I nibble lines and tweak a flag,
Hooks leap forward, no need to lag.
A tiny name — "cchk" to run,
Same burrow, same bright sun.
Docs now hum, the workflow's glad. 🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled by default for public repositories
Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 1dfac64 and 9d9816c.

📒 Files selected for processing (2)

README.rst (1 hunks)
pyproject.toml (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (2)

README.rst
pyproject.toml

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (11)

GitHub Check: install (3.13, windows-latest)
GitHub Check: install (3.11, windows-latest)
GitHub Check: install (3.13, ubuntu-24.04)
GitHub Check: install (3.12, ubuntu-24.04)
GitHub Check: install (3.12, macos-latest)
GitHub Check: install (3.12, windows-latest)
GitHub Check: install (3.10, macos-latest)
GitHub Check: install (3.10, windows-latest)
GitHub Check: install (3.9, windows-latest)
GitHub Check: install (3.9, macos-latest)
GitHub Check: Run benchmarks

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch alias-command

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

Other keywords and placeholders

Add @coderabbitai ignore or @coderabbit ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Pull Request Overview

This pull request adds a shorter alias cc for the commit-check command to improve user experience. The change makes the tool more convenient to use by providing a concise alternative to the full command name.

Added cc as an alias script entry point in pyproject.toml
Updated README documentation to mention the new alias
Updated pre-commit hook versions to newer releases

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File	Description
pyproject.toml	Adds `cc` script entry point as alias for `commit-check`
README.rst	Updates usage documentation to include the new `cc` alias
.pre-commit-config.yaml	Updates pre-commit hook versions (unrelated to main feature)

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

codecov · 2025-09-03T02:45:45Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.14%. Comparing base (9d37b32) to head (9d9816c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #268   +/-   ##
=======================================
  Coverage   99.14%   99.14%           
=======================================
  Files           8        8           
  Lines         350      350           
=======================================
  Hits          347      347           
  Misses          3        3

☔ 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 · 2025-09-03T02:49:01Z

CodSpeed Performance Report

Merging #268 will not alter performance

_{Comparing alias-command (9d9816c) with main (3537653)¹}

Summary

✅ 107 untouched benchmarks

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

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

.pre-commit-config.yaml (1)
42-43: Confirm intent: enabling author checks.

These hooks are enabled while comments still say “uncomment if you need.” If this isn’t intentional, re-comment to avoid unexpected local failures for contributors.
-    -   id: check-author-name     # uncomment if you need.
-    -   id: check-author-email    # uncomment if you need.
+#   -   id: check-author-name     # uncomment if you need.
+#   -   id: check-author-email    # uncomment if you need.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled by default for public repositories
Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 9d37b32 and 1dfac64.

📒 Files selected for processing (3)

.pre-commit-config.yaml (3 hunks)
README.rst (1 hunks)
pyproject.toml (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (8)

GitHub Check: install (3.11, windows-latest)
GitHub Check: install (3.13, windows-latest)
GitHub Check: install (3.10, macos-latest)
GitHub Check: install (3.12, windows-latest)
GitHub Check: install (3.10, windows-latest)
GitHub Check: install (3.9, windows-latest)
GitHub Check: install (3.9, macos-latest)
GitHub Check: Run benchmarks

🔇 Additional comments (1)

.pre-commit-config.yaml (1)

12-12: Version bumps look good.

Pinned to recent tags; no obvious incompatibilities from the config alone.

Also applies to: 22-22, 28-28, 38-38

pyproject.toml

sonarqubecloud · 2025-09-03T06:11:44Z

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

shenxianpeng added 2 commits September 3, 2025 05:35

feat: add alias for commit-check

1170e2b

chore: pre-commit autoupdate

1dfac64

shenxianpeng added the enhancement New feature or request label Sep 3, 2025

shenxianpeng requested a review from a team as a code owner September 3, 2025 02:44

github-actions bot added the documentation Improvements or additions to documentation label Sep 3, 2025

shenxianpeng requested a review from Copilot September 3, 2025 02:44

Copilot AI reviewed Sep 3, 2025

View reviewed changes

coderabbitai bot reviewed Sep 3, 2025

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

fix: rename cc to cchk

9d9816c

shenxianpeng changed the title ~~feat: add alias cc for commit-check~~ feat: add alias cchk for commit-check Sep 3, 2025

shenxianpeng merged commit bed0271 into main Sep 3, 2025
29 checks passed

shenxianpeng deleted the alias-command branch September 3, 2025 06:25

shenxianpeng removed the documentation Improvements or additions to documentation label Sep 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add alias `cchk` for `commit-check` #268

feat: add alias `cchk` for `commit-check` #268

Uh oh!

shenxianpeng commented Sep 3, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Sep 3, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Status, Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

codecov bot commented Sep 3, 2025 •

edited

Loading

Uh oh!

codspeed-hq bot commented Sep 3, 2025 •

edited

Loading

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

sonarqubecloud bot commented Sep 3, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

feat: add alias cchk for commit-check #268

feat: add alias cchk for commit-check #268

Uh oh!

Conversation

shenxianpeng commented Sep 3, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Possibly related PRs

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

codecov bot commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

codspeed-hq bot commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging #268 will not alter performance

Summary

Footnotes

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonarqubecloud bot commented Sep 3, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat: add alias `cchk` for `commit-check` #268

feat: add alias `cchk` for `commit-check` #268

shenxianpeng commented Sep 3, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 3, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Sep 3, 2025 •

edited

Loading

codspeed-hq bot commented Sep 3, 2025 •

edited

Loading