feat: add config option for line length warning #1574
Conversation
…l sites of get_version
…nsors-readme-action@v1
Bumps [dawidd6/action-homebrew-bump-formula](https://github.com/dawidd6/action-homebrew-bump-formula) from 4 to 5. - [Release notes](https://github.com/dawidd6/action-homebrew-bump-formula/releases) - [Commits](dawidd6/action-homebrew-bump-formula@v4...v5) --- updated-dependencies: - dependency-name: dawidd6/action-homebrew-bump-formula dependency-version: '5' dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <[email protected]>
It was added in commitizen-tools#1070 but never documented AFAICT.
|
Sorry, I accidentally closed this pull request. |
|
let's rebase from |
Narwhal-fish
force-pushed
the
feat/Add-config-option-for-line-length-warning
branch
from
9a2622f to
c300b70
Compare
|
I have rebased my branch onto v4-9-0. |
You've done it perfectly 🙂 I'll take a look when bandwidth allow |
…th it Warn if a given decimal string is not in range
commitizen/commands/check.py
Outdated
| raise CommitMessageLengthExceededError( | ||
| f"commit validation: failed!\n" | ||
| f"commit message length exceeds the limit.\n" | ||
| f'commit "": "{commit_msg}"\n' |
There was a problem hiding this comment.
what does "" mean here
There was a problem hiding this comment.
I guess you forgot to put something like commit hash here in the error message
There was a problem hiding this comment.
You’re right. I referenced the error handling for invalid messages and forgot to add the commit hash. I’ll make the correction.
commitizen/defaults.py
Outdated
| @@ -108,6 +109,7 @@ class Settings(TypedDict, total=False): | |||
| "always_signoff": False, | |||
| "template": None, # default provided by plugin | |||
| "extras": {}, | |||
| "message_length_limit": 0, # 0 for no limit | |||
There was a problem hiding this comment.
Why don't we just use None for no limit?
There was a problem hiding this comment.
Initially, I set it to 0 simply because I thought commit messages wouldn't have a 0-character scenario, but your suggestion of using None is more clear. I've made this change accordingly.
…elated logic, types, and tests
…ecessary filter, use named tuple for options
Original "push" stage has been deprecated since pre-commit v3.2.0. See pre-commit/pre-commit#2732 and pre-commit/pre-commit#2808 for detailed information.
…ig function for readability
|
we might need to resolve the conflict first. Thanks! |
Description
This PR implements configuration file support for the
message_length_limitoption, addressing issue #1571 . Previously, users could only set commit message length limits via command-line arguments (-l/--message-length-limit). Now they can define a default limit in their configuration file.Checklist
Code Changes
poetry alllocally to ensure this change passes linter check and testsDocumentation Changes
poetry doclocally to ensure the documentation pages renders correctlyExpected Behavior
Users can now set default commit message length limits in their configuration file:
Steps to Test This Pull Request
Additional Context