To get that list, I've used ``` git log | grep --fixed-strings -- "-by:" | head -n 100000 | sort | less ``` on the Linux kernel's git repository. Signed-off-by: Philipp Schuster <philipp.schuster@cyberus-technology.de> On-behalf-of: SAP philipp.schuster@sap.com
78 lines
2 KiB
Python
78 lines
2 KiB
Python
# SPDX-License-Identifier: Apache-2.0
|
|
|
|
from gitlint.rules import LineRule, RuleViolation, CommitMessageBody
|
|
import re
|
|
|
|
|
|
IGNORE_PREFIXES = [
|
|
# Please sort alphabetically
|
|
"Acked-by: ",
|
|
"Co-authored-by: ",
|
|
"Co-developed-by: ",
|
|
"Debugged-by: ",
|
|
"Diagnosed-by: ",
|
|
"Explained-by: ",
|
|
"Fixed-by: ",
|
|
"Fixes: ",
|
|
"Helped-by: ",
|
|
"Inspired-by: ",
|
|
"On-behalf-of: ",
|
|
"Originally-by: ",
|
|
"Reported-by: ",
|
|
"Reviewed-and-tested-by: ",
|
|
"Reviewed-by: ",
|
|
"Signed-off-by: ",
|
|
"Suggested-by: ",
|
|
"Tested-by: ",
|
|
"Triggered-by: ",
|
|
]
|
|
|
|
|
|
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
|
|
|
|
# Don't check lines with allowed prefixes
|
|
for prefix in IGNORE_PREFIXES:
|
|
if line.startswith(prefix):
|
|
return None
|
|
|
|
return [
|
|
RuleViolation(self.id, f"Line '{line}' exceeds limit of {self.max_len}")
|
|
]
|