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
InvalidCommitMessageError
to give better/more detailed feedback to the user.Checklist
./scripts/format
and./scripts/test
locally to ensure this change passes linter check and testExpected behavior
The developer of a custom commitizen class can override the
validate_commit_message
andformat_error_message
methods 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_succeed
andtest_check_command_with_custom_validator_fail
tests intest_check_command.py
.Additional context
This PR implements and fixes the comments from #648.