summaryrefslogtreecommitdiffstats
path: root/gitlint-core/gitlint/contrib/rules/conventional_commit.py
diff options
context:
space:
mode:
Diffstat (limited to 'gitlint-core/gitlint/contrib/rules/conventional_commit.py')
-rw-r--r--gitlint-core/gitlint/contrib/rules/conventional_commit.py37
1 files changed, 37 insertions, 0 deletions
diff --git a/gitlint-core/gitlint/contrib/rules/conventional_commit.py b/gitlint-core/gitlint/contrib/rules/conventional_commit.py
new file mode 100644
index 0000000..705b083
--- /dev/null
+++ b/gitlint-core/gitlint/contrib/rules/conventional_commit.py
@@ -0,0 +1,37 @@
+import re
+
+from gitlint.options import ListOption
+from gitlint.rules import CommitMessageTitle, LineRule, RuleViolation
+
+RULE_REGEX = re.compile(r"([^(]+?)(\([^)]+?\))?!?: .+")
+
+
+class ConventionalCommit(LineRule):
+ """This rule enforces the spec at https://www.conventionalcommits.org/."""
+
+ name = "contrib-title-conventional-commits"
+ id = "CT1"
+ target = CommitMessageTitle
+
+ options_spec = [
+ ListOption(
+ "types",
+ ["fix", "feat", "chore", "docs", "style", "refactor", "perf", "test", "revert", "ci", "build"],
+ "Comma separated list of allowed commit types.",
+ )
+ ]
+
+ def validate(self, line, _commit):
+ violations = []
+ match = RULE_REGEX.match(line)
+
+ if not match:
+ msg = "Title does not follow ConventionalCommits.org format 'type(optional-scope): description'"
+ violations.append(RuleViolation(self.id, msg, line))
+ else:
+ line_commit_type = match.group(1)
+ if line_commit_type not in self.options["types"].value:
+ opt_str = ", ".join(self.options["types"].value)
+ violations.append(RuleViolation(self.id, f"Title does not start with one of {opt_str}", line))
+
+ return violations