From 4aa47300859535944ba997e4a69483b0da07b578 Mon Sep 17 00:00:00 2001 From: Musselman Date: Thu, 22 Aug 2024 15:21:04 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=8E=A8=20Chore:=20Add=20Git=20Sumi?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Git Sumi provides commit message linting --- sumi.toml | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 sumi.toml diff --git a/sumi.toml b/sumi.toml new file mode 100644 index 0000000..2d20711 --- /dev/null +++ b/sumi.toml @@ -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 = ""