Feature/ add a tag(--body-length-limit) for command commit

[yjaw]

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:

1. Split the body into separate lines using the \n character.
2. Start from the third line, where the body begins. Use textwrap to rewrap that line.
3. 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

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

Steps to Test This Pull Request

1. 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]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.00%. Comparing base (26e5d80) to head (1f74bb2).
⚠️ Report is 15 commits behind head on master.
✅ All tests successful. No failed tests found.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1849      +/-   ##
==========================================
+ Coverage   97.98%   98.00%   +0.01%     
==========================================
  Files          60       60              
  Lines        2686     2711      +25     
==========================================
+ Hits         2632     2657      +25     
  Misses         54       54              

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

[bearomorphism]

Thanks!

[bearomorphism]

The number 72 should be extracted.

[bearomorphism]

Add a file regression check here and remove assert line[0] == ... and assert line[1] == ...

[bearomorphism]

Please reuse commit_mock fixture. Same for other new tests.

[bearomorphism]

This if can be removed?

[bearomorphism]

Why not <=?

[bearomorphism]

I think all the new tests can be merged into one and use parameterize to shorten the tests

Basically we can do like following:

fixtures
parameterize
def test_...(...):
    mocker.patch(
        "questionary.prompt",
        return_value={
            "prefix": "feat",
            "subject": "add feature",
            "scope": "",
            "is_breaking_change": False,
            "body": body, # parameterized, can be a long text with / without line breaks or short strings or an empty string
            "footer": "",
        },
    )

    # commit with parameterized config

    # check each line in line[2:] does not exceed the line length limit if it is not 0

    # file regression check

[bearomorphism]

Suggested change

	if (
	body_length_limit is None or body_length_limit <= 0
	): # do nothing for no limit
	if (
	body_length_limit <= 0
	): # do nothing for no limit

[bearomorphism]

Suggested change

	message_parts = message.split("\n", 2)
	lines = message.split("\n")

and I'm entirely not sure whether there will be issues related to LF and CRLF. Need to check further

[bearomorphism]

Suggested change

	# First line is subject, second is blank line, rest is body
	subject = message_parts[0]
	blank_line = message_parts[1]
	body = message_parts[2].strip()
	body_lines = body.split("\n")
	wrapped_body_lines = []
	for line in body_lines:
	wrapped_body_lines.append(textwrap.fill(line, width=body_length_limit))
	wrapped_body = "\n".join(wrapped_body_lines)
	return f"{subject}\n{blank_line}\n{wrapped_body}"
	# First line is subject, second is blank line, rest is body
	wrapped_body_lines = [textwrap.fill(line, width=body_length_limit) for line in lines[2:]]
	return "\n".join(chain(lines[:2], wrapped_body_lines))