77e042237d
Follow-up of 5aa1540c5d but way more
mature. We now use custom gitlint rules written in Python to better
handle the max line length, with respect to a few valid exceptions.
Recognizing code blocks or compiler output, as discussed, is not
trivial and hard to get right for all corner-cases. Therefore, this
commit is a pragmatic way forward. The CI job should be kept optional.
Allowed exceptions for the 72 line length limit are now:
1. links in the following three common patterns:
https://example.com/very-long-links/very-long-links/very-long-links/very-long-links/very-long-links/very-long-links/very-long-links
[0] https://example.com/very-long-links/very-long-links/very-long-links/very-long-links/very-long-links/very-long-links/very-long-links
[0]: https://example.com/very-long-links/very-long-links/very-long-links/very-long-links/very-long-links/very-long-links/very-long-links
2. code blocks (anything between the three backticks)
```
let x = "very_long_very_long_very_long_very_long_very_long_very_long_very_long_very_long_very_long_very_long_"
```
Signed-off-by: Philipp Schuster <philipp.schuster@cyberus-technology.de>
On-behalf-of: SAP philipp.schuster@sap.com
49 lines
1.4 KiB
Python
49 lines
1.4 KiB
Python
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
from gitlint.rules import LineRule, RuleViolation, CommitMessageBody
|
|
import re
|
|
|
|
|
|
class BodyMaxLineLengthEx(LineRule):
|
|
"""A rule to enforce a line limit of 72 characters, except for valid cases."""
|
|
|
|
# A rule MUST have a human friendly name
|
|
name = "body-max-line-length-ex"
|
|
|
|
# A rule MUST have a *unique* id.
|
|
# We recommend starting with UL (for User-defined Line-rule)
|
|
id = "UL-ll"
|
|
|
|
# A line-rule MUST have a target (not required for CommitRules).
|
|
target = CommitMessageBody
|
|
|
|
max_len = 72
|
|
|
|
# Updated property as the commit messages is validated line by line.
|
|
inside_open_codeblock = False
|
|
|
|
def validate(self, line, commit):
|
|
# Pattern allowing:
|
|
# - [0]: https://foobar
|
|
# - [0] https://foobar
|
|
# - https://foobar
|
|
link_regex = re.compile(r"^((\[[0-9]+\]:?\s?)?https?:\/\/).*$")
|
|
|
|
is_codeblock_marker = line.startswith("```")
|
|
|
|
inside_open_codeblock_ = self.inside_open_codeblock
|
|
if is_codeblock_marker:
|
|
self.inside_open_codeblock = not self.inside_open_codeblock
|
|
|
|
if len(line) > self.max_len:
|
|
is_link = link_regex.match(line)
|
|
|
|
if inside_open_codeblock_:
|
|
return
|
|
|
|
if is_link:
|
|
return
|
|
|
|
return [
|
|
RuleViolation(self.id, f"Line '{line}' exceeds limit of {self.max_len}")
|
|
]
|