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.

benediktziegler requested review fromLee-W,noirbizarre andwoile ascode owners

September 13, 2024 12:28

github-actionsbot added the pr-status: wait-for-review label

Sep 13, 2024

Copy link

codecovbot commentedSep 13, 2024•
edited
Loading

Codecov Report

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

Additional details and impacted files

@@            Coverage Diff             @@##             v4-11-0    #1236   +/-   ##==========================================  Coverage           ?   98.64%           ==========================================  Files              ?       60             Lines              ?     2664             Branches           ?        0           ==========================================  Hits               ?     2628             Misses             ?       36             Partials           ?        0

Flag	Coverage Δ
unittests	`98.64% <100.00%> (?)`

Flags with carried forward coverage won't be shown.Click here to find out more.

☔ 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.

benediktziegler force-pushed thefeature/custom-validation branch fromfbf3813 to7bd16c3Compare

September 13, 2024 13:57

Copy link

Author

benediktziegler commentedSep 20, 2024

@Lee-W I was wondering if you had any input to this PR?

Copy link

Member

Lee-W commentedSep 25, 2024

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

View reviewed changes

Copy link

Member

Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Overall, I love this idea! left a few improvement suggestions

commitizen/cz/base.pyShow resolvedHide resolved

commitizen/cz/base.py OutdatedShow resolvedHide resolved

Lee-W added pr-status: wait-for-modification and removed pr-status: wait-for-review labels

Nov 10, 2024

github-actionsbot added the pr-status: wait-for-review label

Nov 18, 2024

benediktziegler requested a review fromLee-W

November 18, 2024 16:05

Copy link

Member

Lee-W commentedDec 6, 2024

I'll be mostly out for the following month. Will try to take a look when I'm back.

Lee-W reviewed

Jan 30, 2025

View reviewed changes

Copy link

Member

Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Sorry for taking so long. Some nitpicks. but we're close to merge I think!

docs/customization.md OutdatedShow resolvedHide resolved

commitizen/cz/base.py OutdatedShow resolvedHide resolved

Lee-W added type: featureA new enhacement proposal and removed pr-status: wait-for-review labels

Jan 30, 2025

Lee-W added this to the4.10.0 milestone

Sep 9, 2025

github-actionsbot added the pr-status: wait-for-review label

Oct 22, 2025

woile reviewed

Oct 22, 2025

View reviewed changes

commitizen/cz/base.pyShow resolvedHide resolved

Lee-W reviewed

Nov 19, 2025

View reviewed changes

commitizen/cz/base.pyShow resolvedHide resolved

docs/customization.md OutdatedShow resolvedHide resolved

tests/commands/test_check_command.py OutdatedShow resolvedHide resolved

tests/conftest.py OutdatedShow resolvedHide resolved

Lee-W changed the base branch frommaster tov4-11-0

November 19, 2025 03:20

Copy link

Member

Lee-W commentedNov 19, 2025

Hey@benediktziegler , I left a few nits, but overall this PR is great! We're super close to merging.
We'll include it in 4.11. Hopefully to release some time early Dec

Lee-W approved these changes

Nov 30, 2025

View reviewed changes

Lee-W force-pushed thev4-11-0 branch from1d0f6cb to871b1b5Compare

November 30, 2025 03:00

Copy link

Member

Lee-W commentedNov 30, 2025

Hey@benediktziegler , I think we're almost good to merge this one. But could you please help us rebase from the branchv4-11-0? I tried a bit, but I'm worried I might mess it up.

Lee-W force-pushed thev4-11-0 branch fromd53fb20 to701de0aCompare

November 30, 2025 07:51

feat: add custom validation

265cb98

Copy link

Author

benediktziegler commentedDec 1, 2025•
edited
Loading

@Lee-W I agree the merging was a bit messy and seems to even contain unwanted changes in the end. I propose I force push the squashed changes from this branch into this PR:https://github.com/benediktziegler/commitizen/tree/feature/custom-validation-clean instead.
Do you have any objections?

Or we merge this one instead:#1680