feat(commit): add a tag(--body-length-limit) and a function for command commit by yjaw · Pull Request #1849 · commitizen-tools/commitizen · GitHub

Description

I added a tag (—body-length-limit) for command commit. This tag utilizes Python’s built-in library, textwrap, to rewrap the body. It also respects the user’s |(\n) signal. This tag will affect the footer as well.
The flow is as follows:

Split the body into separate lines using the \n character.
Start from the third line, where the body begins. Use textwrap to rewrap that line.
Reconstruct the entire body message from those rewrapped lines.

Checklist

I have read the contributing guidelines

Was generative AI tooling used to co-author this PR?

Yes (please specify the tool below)

Generated-by: [Gemini] following the guidelines

Code Changes

Add test cases to all the changes you introduce
Run uv run poe all locally to ensure this change passes linter check and tests
Manually test the changes:
- Verify the feature/bug fix works as expected in real-world scenarios
- Test edge cases and error conditions
- Ensure backward compatibility is maintained
- Document any manual testing steps performed
Update the documentation for the changes

Documentation Changes

Run uv run poe doc locally to ensure the documentation pages renders correctly
Check and fix any broken links (internal or external)

Expected Behavior

This option should modify the line length for your message if its length exceeds the limit you’ve set.
Adding this tag or setting it to 0 should have no effect.
If the message body is empty, it will be fine.
This option will affect the text in both the body and footer sections.

Steps to Test This Pull Request

When using the commit command, you can add the —body-length-limit [int] option to set a limit on the length of the commit message. If you don’t want to set a limit, you can set the option to 0.

Additional Context

close #1597

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.26%. Comparing base (a82e8fb) to head (eea3bb8).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1849   +/-   ##
=======================================
  Coverage   98.25%   98.26%           
=======================================
  Files          61       61           
  Lines        2815     2829   +14     
=======================================
+ Hits         2766     2780   +14     
  Misses         49       49

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

Thanks!

Pull request overview

Adds support for limiting/wrapping commit message body line length during cz commit, via a new --body-length-limit CLI option and a corresponding body_length_limit config/default setting.

Changes:

Add body_length_limit to default settings/config schema and expose it as --body-length-limit for cz commit.
Implement body rewrapping logic in the commit command using textwrap.
Add/adjust regression snapshots for cz commit --help and add commit-command tests around the new wrapping behavior.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
commitizen/commands/commit.py	Adds body rewrapping logic (_rewrap_body) during interactive commit message creation.
commitizen/cli.py	Adds --body-length-limit argument to the commit subcommand.
commitizen/defaults.py	Introduces body_length_limit in Settings and DEFAULT_SETTINGS.
tests/test_conf.py	Updates expected default config dictionaries to include body_length_limit.
tests/commands/test_commit_command.py	Adds tests for body wrapping and config/CLI precedence.
tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_10_commit_.txt	Updates CLI help snapshot to include --body-length-limit.
tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_11_commit_.txt	Updates CLI help snapshot to include --body-length-limit.
tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_12_commit_.txt	Updates CLI help snapshot to include --body-length-limit.
tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_13_commit_.txt	Updates CLI help snapshot to include --body-length-limit.
tests/commands/test_common_command/test_command_shows_description_when_use_help_option_py_3_14_commit_.txt	Updates CLI help snapshot to include --body-length-limit.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

There are conflicts. Turning this PR to draft

Many thanks for this PR, exactly what I'm looking for 😊

Any help needed to move this over the finish line?

Thanks for the reminder. I believe the maintainers barely have bandwidth to review PRs. I'll take a quick look.

LGTM.

Could you rebase? 🙏🏻

…nd commit

…limit in commit command

… in commit

…d use tuple argument in pytest.mark.parametrize

The test was previously passing even if the code accidentally skipped the argument setting, which was incorrect. I realized I was always overriding the configuration in the test. Now, I pass the argument setting during mocking, and it behaves as expected.

…nd commit (commitizen-tools#1849)

yjaw requested review from Lee-W, noirbizarre and woile as code owners February 5, 2026 00:16

github-actions Bot added pr-status: wait-for-review type: feature A new enhacement proposal labels Feb 5, 2026

bearomorphism reviewed Feb 5, 2026

View reviewed changes

bearomorphism added pr-status: wait-for-modification and removed pr-status: wait-for-review labels Feb 5, 2026

github-actions Bot added the pr-status: wait-for-review label Feb 5, 2026

bearomorphism reviewed Feb 6, 2026

View reviewed changes

Comment thread commitizen/commands/commit.py Outdated

Comment thread commitizen/commands/commit.py Outdated

Comment thread tests/commands/test_commit_command.py Outdated

Comment thread commitizen/commands/commit.py Outdated

bearomorphism removed the pr-status: wait-for-review label Feb 6, 2026

bearomorphism requested a review from Copilot February 7, 2026 02:06

Copilot started reviewing on behalf of bearomorphism February 7, 2026 02:07 View session

Copilot AI reviewed Feb 7, 2026

View reviewed changes

Comment thread commitizen/commands/commit.py Outdated

Comment thread tests/commands/test_commit_command.py Outdated

Comment thread tests/commands/test_commit_command.py

Lee-W reviewed Feb 7, 2026

View reviewed changes

Comment thread commitizen/commands/commit.py Outdated

Comment thread commitizen/commands/commit.py

Comment thread commitizen/commands/commit.py Outdated

Comment thread commitizen/cli.py

yjaw force-pushed the feature/commit-line-limt branch from 49bb71b to 071e450 Compare February 7, 2026 10:38

github-actions Bot added the pr-status: wait-for-review label Feb 7, 2026

bearomorphism reviewed Feb 8, 2026

View reviewed changes

Comment thread tests/commands/test_commit_command.py Outdated

bearomorphism reviewed Feb 8, 2026

View reviewed changes

Comment thread tests/commands/test_commit_command.py Outdated

bearomorphism reviewed Feb 8, 2026

View reviewed changes

Comment thread commitizen/commands/commit.py Outdated

bearomorphism reviewed Feb 8, 2026

View reviewed changes

Comment thread tests/commands/test_commit_command.py Outdated

woile reviewed Feb 8, 2026

View reviewed changes

Comment thread commitizen/commands/commit.py

Comment thread commitizen/cli.py

Comment thread commitizen/commands/commit.py Outdated

bearomorphism marked this pull request as draft February 9, 2026 11:59

yjaw marked this pull request as ready for review February 9, 2026 23:16

bearomorphism mentioned this pull request May 9, 2026

Triage audit (round 3): 8 newer bugs + 22 older feature/refactor items (May 2026) #1976

Open

30 tasks

bearomorphism approved these changes Aug 6, 2026

View reviewed changes

bearomorphism requested review from Lee-W and woile August 6, 2026 08:00

Lee-W approved these changes Aug 19, 2026

View reviewed changes

Lee-W enabled auto-merge (squash) August 19, 2026 03:29

Lee-W changed the title Feature/ add a tag(--body-length-limit) for command commit feat(commit): add a tag(--body-length-limit) and a function for command commit Aug 19, 2026

yjaw added 7 commits August 19, 2026 15:13

feat(commit): add a tag(--body-length-limit) and a function for comma…

b076927

…nd commit

test(commit): add some test for commit --body-length-limit flag

eff56e5

refactor(commit): refactor test case and logic for tag --body-length-…

52c3e20

…limit in commit command

refactor(commit): rewrite logic and test for tag: --body-length-limit…

d80393b

… in commit

fix(commit): add default value for --body-length-tag in the cli.py an…

078412d

…d use tuple argument in pytest.mark.parametrize

fix(commit): fix some code and test according to suggestions

eea3bb8

Lee-W force-pushed the feature/commit-line-limt branch from f17a654 to eea3bb8 Compare August 19, 2026 07:16

Lee-W disabled auto-merge August 19, 2026 14:45

Lee-W merged commit 363508d into commitizen-tools:master Aug 19, 2026
21 checks passed

vemilano pushed a commit to vemilano/commitizen that referenced this pull request Aug 24, 2026

feat(commit): add a tag(--body-length-limit) and a function for comma…

4ce8164

…nd commit (commitizen-tools#1849)

feat(commit): add a tag(--body-length-limit) and a function for command commit by yjaw · Pull Request #1849 · commitizen-tools/commitizen · GitHub

Uh oh!

Uh oh!

feat(commit): add a tag(--body-length-limit) and a function for command commit - #1849

feat(commit): add a tag(--body-length-limit) and a function for command commit#1849Lee-W merged 7 commits intocommitizen-tools:mastercommitizen-tools/commitizen:masterfrom yjaw:feature/commit-line-limtyjaw/commitizen:feature/commit-line-limtCopy head branch name to clipboard

Conversation

yjaw commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Was generative AI tooling used to co-author this PR?

Code Changes

Documentation Changes

Expected Behavior

Steps to Test This Pull Request

Additional Context

Uh oh!

codecov Bot commented Feb 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

bearomorphism left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bearomorphism commented Feb 9, 2026

Uh oh!

schlotter commented Aug 6, 2026

Uh oh!

bearomorphism commented Aug 6, 2026

Uh oh!

bearomorphism left a comment

Choose a reason for hiding this comment

Uh oh!

woile commented Aug 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

feat(commit): add a tag(--body-length-limit) and a function for command commit#1849
Lee-W merged 7 commits into
commitizen-tools:masterfrom
yjaw:feature/commit-line-limt

yjaw commented Feb 5, 2026 •
edited
Loading

codecov Bot commented Feb 5, 2026 •
edited
Loading