🎨 Chore: Add Git Sumi

Git Sumi provides commit message linting
This commit is contained in:
James Musselman 2024-08-22 15:21:04 -05:00
parent 7f2ee64e80
commit 4aa4730085
Signed by: Musselman
GPG key ID: 1DAEFF35ECB5D6DB

56
sumi.toml Normal file
View file

@ -0,0 +1,56 @@
# git-sumi ~ configuration file
# Config: https://sumi.rs/docs/configuration
# Rules: https://sumi.rs/docs/rules
# Suppresses progress messages.
quiet = false
# Displays parsed commit message.
display = false
# Sets display format: cli, json, table, toml.
format = "cli"
# Processes each non-empty line as an individual commit.
split_lines = false
# Rule: Include one valid Gitmoji.
# See https://gitmoji.dev/.
gitmoji = true
# Rule: Description must start with the specified case.
# Options: 'any', 'lower', 'upper'.
description_case = "upper"
# Rule: Use the imperative mood in the description.
# Example: 'Fix bug' instead of 'Fixed bug'.
imperative = true
# Rule: Do not end commit header with a period.
no_period = true
# Rule: Header length limit.
# A value of 0 disables the rule.
max_header_length = 60
# Rule: Body line length limit.
# A value of 0 disables the rule.
max_body_length = 150
# Rule: No leading, trailing, or consecutive spaces.
whitespace = true
# Rule: Follow Conventional Commits format.
# See https://www.conventionalcommits.org/.
conventional = false
# Rule: List of allowed commit scopes.
# An empty list allows all scopes. Example: ["docs", "cli"].
scopes_allowed = []
# Rule: List of allowed commit types.
# An empty list allows all types. Example: ["feat", "fix", "docs"].
types_allowed = ["Feature", "Fix", "Docs", "Chore", "Refactor"]
# Rule: Header must match regex pattern.
# Example: '^JIRA-\d+:'.
header_pattern = ""