72 lines
2.6 KiB
Python
72 lines
2.6 KiB
Python
from gitlint.options import IntOption, ListOption, StrOption
|
|
from gitlint.rules import CommitRule, ConfigurationRule, RuleViolation
|
|
|
|
|
|
class GitContextRule(CommitRule):
|
|
"""Rule that tests whether we can correctly access certain gitcontext properties"""
|
|
|
|
name = "gïtcontext"
|
|
id = "UC1"
|
|
|
|
def validate(self, commit):
|
|
violations = [
|
|
RuleViolation(self.id, f"GitContext.current_branch: {commit.context.current_branch}", line_nr=1),
|
|
RuleViolation(self.id, f"GitContext.commentchar: {commit.context.commentchar}", line_nr=1),
|
|
]
|
|
|
|
return violations
|
|
|
|
|
|
class GitCommitRule(CommitRule):
|
|
"""Rule that tests whether we can correctly access certain commit properties"""
|
|
|
|
name = "gïtcommit"
|
|
id = "UC2"
|
|
|
|
def validate(self, commit):
|
|
violations = [
|
|
RuleViolation(self.id, f"GitCommit.branches: {commit.branches}", line_nr=1),
|
|
RuleViolation(self.id, f"GitCommit.custom_prop: {commit.custom_prop}", line_nr=1),
|
|
]
|
|
|
|
return violations
|
|
|
|
|
|
class GitlintConfigurationRule(ConfigurationRule):
|
|
"""Rule that tests whether we can correctly access the config as well as modify the commit message"""
|
|
|
|
name = "cönfigrule"
|
|
id = "UC3"
|
|
|
|
def apply(self, config, commit):
|
|
# We add a line to the commit message body that pulls a value from config, this proves we can modify the body
|
|
# and read the config contents
|
|
commit.message.body.append(f"{config.target} ") # trailing whitespace deliberate to trigger violation
|
|
|
|
# We set a custom property that we access in CommitRule, to prove we can add extra properties to the commit
|
|
commit.custom_prop = "foöbar"
|
|
|
|
# We also ignore some extra rules, proving that we can modify the config
|
|
config.ignore.append("B4")
|
|
|
|
|
|
class ConfigurableCommitRule(CommitRule):
|
|
"""Rule that tests that we can add configuration to user-defined rules"""
|
|
|
|
name = "configürable"
|
|
id = "UC4"
|
|
|
|
options_spec = [
|
|
IntOption("int-öption", 2, "int-öption description"),
|
|
StrOption("str-öption", "föo", "int-öption description"),
|
|
ListOption("list-öption", ["foo", "bar"], "list-öption description"),
|
|
]
|
|
|
|
def validate(self, _):
|
|
violations = [
|
|
RuleViolation(self.id, f"int-öption: {self.options['int-öption'].value}", line_nr=1),
|
|
RuleViolation(self.id, f"str-öption: {self.options['str-öption'].value}", line_nr=1),
|
|
RuleViolation(self.id, f"list-öption: {self.options['list-öption'].value}", line_nr=1),
|
|
]
|
|
|
|
return violations
|