feat: add custom validation #1236
Open
Conversation
This file contains 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
benediktziegler
requested review from
woile,
Lee-W and
noirbizarre
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1236 +/- ##
==========================================
+ Coverage 97.33% 97.55% +0.21%
==========================================
Files 42 55 +13
Lines 2104 2614 +510
==========================================
+ Hits 2048 2550 +502
- Misses 56 64 +8
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
benediktziegler
force-pushed
the
feature/custom-validation
branch
from
fbf3813
to
7bd16c3
Compare
|
@Lee-W I was wondering if you had any input to this PR? |
|
I'll be mostly out till at least mid-Oct, will try to check in depth after that. Thanks! |
Lee-W
reviewed
Nov 10, 2024
commitizen/cz/base.py
Outdated
| allow_abort: bool, | ||
| allowed_prefixes: list[str], | ||
| max_msg_length: int, | ||
| ) -> tuple[bool, list]: |
There was a problem hiding this comment.
Could we make the return type a named tuple for explicity?
There was a problem hiding this comment.
I added a named tuple ValidationResult. Let me know it the solution works for you.
Lee-W
added
pr-status: wait-for-modification
and removed
pr-status: wait-for-review
labels
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.
Description
This PR adds functionality to customise the commit message validation and to format the
InvalidCommitMessageErrorto give better/more detailed feedback to the user.Checklist
./scripts/formatand./scripts/testlocally to ensure this change passes linter check and testExpected behavior
The developer of a custom commitizen class can override the
validate_commit_messageandformat_error_messagemethods to perform more complex commit message format checks then just a regex match and give more detailed feedback on failure.Steps to Test This Pull Request
Run the the
test_check_command_with_custom_validator_succeedandtest_check_command_with_custom_validator_failtests intest_check_command.py.Additional context
This PR implements and fixes the comments from #648.