gitlint_core_string_commit_message_linting_quickstart.py

1from gitlint.lint import GitLinter
2from gitlint.config import LintConfig
3from gitlint.git import GitContext
4
5# 1. Create a configuration object
6config = LintConfig()
7
8# 2. Create a GitContext (required for the linter)
9# For string-based linting, we can create an empty context
10context = GitContext.from_commit_msg("WIP: This is a commit message\n\nIt has no period")
11
12# 3. Initialize the linter with the config
13linter = GitLinter(config)
14
15# 4. Run the linting
16violations = linter.lint(context.commits[0])
17
18# 5. Output results
19for violation in violations:
20    print(f"{violation.rule_id}: {violation.message} (Line {violation.line_nr})")