feat: add alias cchk for commit-check#268
Conversation
WalkthroughBumps several pre-commit hook revisions, adds a new CLI alias Changes
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
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
⏰ 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)
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
github-actions
bot
added
the
documentation
There was a problem hiding this comment.
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
ccas 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 Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
CodSpeed Performance ReportMerging #268 will not alter performanceComparing Summary
Footnotes |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
📒 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
|
shenxianpeng
changed the title
cc for commit-checkcchk for commit-check
1 participant
part of #264
Summary by CodeRabbit
New Features
Documentation
Chores