NotificationsYou must be signed in to change notification settings
Fork304
Star3.2k

feat: add custom validation#1680

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

benediktziegler wants to merge1 commit intocommitizen-tools:v4-11-0frombenediktziegler:feature/custom-validation-clean

Closed

feat: add custom validation#1680

benediktziegler wants to merge1 commit intocommitizen-tools:v4-11-0frombenediktziegler:feature/custom-validation-clean

+280 −36

Conversation

Copy link

benediktziegler commentedDec 1, 2025•
edited
Loading

Description

This PR adds functionality to customise the commit message validation and to format theInvalidCommitMessageError to give better/more detailed feedback to the user.

Checklist

Add test cases to all the changes you introduce
Run./scripts/format and./scripts/test locally to ensure this change passes linter check and test
Test the changes on the local machine manually
Update the documentation for the changes

Expected behavior

The developer of a custom commitizen class can override thevalidate_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 thetest_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.
Cleaned up version of#1236

feat: add custom validation

265cb98

github-actionsbot added pr-status: wait-for-review type: featureA new enhacement proposal labels

Dec 1, 2025

benediktziegler mentioned this pull request

Dec 1, 2025

feat: add custom validation#1236

Merged

4 tasks

Copy link

codecovbot commentedDec 1, 2025•
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Pleaseupload report for BASE (v4-11-0@701de0a).Learn more about missing BASE report.

Additional details and impacted files

@@            Coverage Diff             @@##             v4-11-0    #1680   +/-   ##==========================================  Coverage           ?   98.68%           ==========================================  Files              ?       60             Lines              ?     2655             Branches           ?        0           ==========================================  Hits               ?     2620             Misses             ?       35             Partials           ?        0