git-lint 6.2.1 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 617855a3e3ab47a5f4e831cfc6b8c3d8fa0cba5554ff0c5d3af7d53ad872fcc1
-  data.tar.gz: 72b172b848660e05381833707645a193b996c381fd200b102eeb7e536787dfff
+  metadata.gz: fbecb342f45a5216dfdbf7c947467c6d565d8a1f98481d8a7765f2de1b7cc621
+  data.tar.gz: cd56aed86788d514cde91d342fc9acdafa4d4d42957a473902d361782bb98375
 SHA512:
-  metadata.gz: f6dca36573819ff8ca65210dad90ed5a8104a1b096c35ce3ce601dcf71b2b413a5bf1664a5b96e17fb9ef8913d4d6e33b25675cc7128aafe20fffbe37abc4b00
-  data.tar.gz: 1dee5dc39b0c9f0aa54d436f27fb0b50306f33c71740dbd89a69b38e2c8f917ab23510e6b68210738c635a729ff364c404a45a75d0e06f9882eecc2d274098f9
+  metadata.gz: 9a6d9d4edb2b3410956f8e47ea213c35702be39bcbc2a0321565f5f029a59a5deede96a89f81ba64d749e4316d4be85455c81a9262dd2c2a8498ef47a32e40bc
+  data.tar.gz: e3a1bcf8e6e06877b53b50b151734b3770fa7be872e3496918810328e772390d9c6f59dc1a21f3ca7242f1667baafea45e41af230ccf11419834d6be2f56e324

data/README.adoc

@@ -112,22 +112,24 @@ commits:
       severity: error
       minimum: 2
   body:
-    bullet:
+    bullet_capitalization:
       enabled: true
       severity: error
-      excludes:
+      includes:
+        - "\\-"
         - "\\*"
-        - "•"
-    bullet_capitalization:
+    bullet_delimiter:
       enabled: true
       severity: error
       includes:
         - "\\-"
-    bullet_delimiter:
+        - "\\*"
+    bullet_only:
       enabled: true
       severity: error
       includes:
         - "\\-"
+        - "\\*"
     leading_line:
       enabled: true
       severity: warn
@@ -148,6 +150,7 @@ commits:
         - "along the lines"
         - "at this moment in time"
         - "basically"
+        - "blacklist"
         - "each and every one"
         - "everyone knows"
         - "fact of the matter"
@@ -162,6 +165,7 @@ commits:
         - "really"
         - "simply"
         - "things being equal"
+        - "whitelist"
         - "would like to"
         - "\\beasy\\b"
         - "\\bjust\\b"
@@ -172,11 +176,6 @@ commits:
       enabled: true
       severity: warn
       minimum: 1
-    single_bullet:
-      enabled: true
-      severity: error
-      includes:
-        - "\\-"
     tracker_shorthand:
       enabled: true
       severity: error
@@ -184,6 +183,9 @@ commits:
         - "(f|F)ix(es|ed)?\\s\\#\\d+"
         - "(c|C)lose(s|d)?\\s\\#\\d+"
         - "(r|R)esolve(s|d)?\\s\\#\\d+"
+    word_repeat:
+      enabled: true
+      severity: error
   signature:
     enabled: false
     severity: error
@@ -211,6 +213,9 @@ commits:
         - "\\."
         - "\\?"
         - "\\!"
+    word_repeat:
+      enabled: true
+      severity: error
   trailer:
     collaborator_capitalization:
       enabled: true
@@ -221,8 +226,6 @@ commits:
     collaborator_key:
       enabled: true
       severity: error
-      includes:
-        - Co-Authored-By
     collaborator_name:
       enabled: true
       severity: error
@@ -233,24 +236,46 @@ commits:
     format_key:
       enabled: true
       severity: error
-      includes:
-        - Format
     format_value:
       enabled: true
       severity: error
       includes:
-        - ASCII
-        - Markdown
+        - asciidoc
+        - markdown
     issue_key:
       enabled: true
       severity: error
-      includes:
-        - Issue
     issue_value:
       enabled: true
       severity: error
       includes:
         - "[\\w-]+"
+    milestone_key:
+      enabled: true
+      severity: error
+    milestone_value:
+      enabled: true
+      severity: error
+      includes:
+        - major
+        - minor
+        - patch
+    order:
+      enabled: true
+      severity: error
+    reviewer_key:
+      enabled: true
+      severity: error
+    reviewer_value:
+      enabled: true
+      severity: error
+      includes:
+        - clickup
+        - github
+        - jira
+        - linear
+        - shortcut
+        - tana
     signer_capitalization:
       enabled: true
       severity: error
@@ -260,8 +285,6 @@ commits:
     signer_key:
       enabled: true
       severity: error
-      includes:
-        - Signed-By
     signer_name:
       enabled: true
       severity: error
@@ -269,8 +292,6 @@ commits:
     tracker_key:
       enabled: true
       severity: error
-      includes:
-        - Tracker
     tracker_value:
       enabled: true
       severity: error
@@ -368,60 +389,69 @@ Kaylee
 Kaywinnet Lee Frye
 ....
 
-==== Commit Body Bullet
+==== Commit Body Bullet Capitalization
 
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| true    | error    | excludes: `["\\*", "•"]`
+| true    | error    | includes: `["\\*", "\\-"]`
 |===
 
-Ensures commit message bodies use a standard Markdown syntax for bullet points. Markdown supports
-the following syntax for bullets:
+Ensures commit body bullet lines are capitalized. Example:
 
 ....
-*
--
+# Disallowed
+- an example bullet.
+
+# Allowed
+* An ASCII Doc bullet.
+* link:https://demo.com[Demo]
+* link:https://demo.com[demo]
+- A Markdown bullet.
+- [Demo](https://demo.com)
+- [demo](https://demo.com)
 ....
 
-It's best to use dashes for bullet point syntax as stars are easier to read when used for
-_emphasis_. This makes parsing the Markdown syntax easier when reviewing a Git commit as the syntax
-used for bullet points and _emphasis_ are now, distinctly, unique.
+In general, using ASCII Doc or Markdown syntax directly after a bullet will cause capitalization checks to be ignored because there can be valid reasons for wanting to avoid capitalization in those situations.
 
-==== Commit Body Bullet Capitalization
+==== Commit Body Bullet Delimiter
 
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| true    | error    | includes: `["\\-"]`
+| true    | error    | includes: `["\\*", "\\-"]`
 |===
 
-Ensures commit body bullet lines are capitalized. Example:
+Ensures commit body bullets are delimited by a space. Example:
 
 ....
 # Disallowed
-- an example bullet.
+-An example bullet.
 
 # Allowed
 - An example bullet.
 ....
 
-==== Commit Body Bullet Delimiter
+==== Commit Body Bullet Only
 
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| true    | error    | includes: `["\\-"]`
+| true    | error    | includes: `["\\*", "\\-"]`
 |===
 
-Ensures commit body bullets are delimited by a space. Example:
+Ensures a single bullet is never used when a paragraph could be used instead. Example:
 
 ....
 # Disallowed
--An example bullet.
+
+- Pellentque morbi-trist sentus et netus et malesuada fames ac turpis egestas. Vestibulum tortor
+  quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu_libero sit amet quam.
 
 # Allowed
-- An example bullet.
+
+Pellentque morbi-trist sentus et netus et malesuada fames ac turpis egestas. Vestibulum tortor
+quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu_libero sit amet quam.
 ....
 
 ==== Commit Body Leading Line
@@ -521,28 +551,6 @@ Ensures a minimum number of lines are present within the commit body. Lines with
 
 Automatically ignores _fixup!_ commits as they are not meant to have bodies.
 
-==== Commit Body Single Bullet
-
-[options="header"]
-|===
-| Enabled | Severity | Defaults
-| true    | error    | includes: `"\\-"`
-|===
-
-Ensures a single bullet is never used when a paragraph could be used instead. Example:
-
-....
-# Disallowed
-
-- Pellentque morbi-trist sentus et netus et malesuada fames ac turpis egestas. Vestibulum tortor
-  quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu_libero sit amet quam.
-
-# Allowed
-
-Pellentque morbi-trist sentus et netus et malesuada fames ac turpis egestas. Vestibulum tortor
-quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu_libero sit amet quam.
-....
-
 ==== Commit Body Tracker Shorthand
 
 [options="header"]
@@ -568,6 +576,24 @@ Instead of using tracker shorthand syntax, take the time to write a short summar
 commit was made. Doing this will make it easier to understand _why_ the commit was made, keeps the
 commit self-contained, and makes learning about/debugging the commit faster.
 
+==== Commit Body Word Repeat
+
+[options="header"]
+|===
+| Enabled | Severity
+| true    | error
+|===
+
+Ensures commit bodies don't contain repeated words. Example:
+
+....
+# Disallowed
+Necessary to to fix production error.
+
+# Allowed
+Necessary to fix production error.
+....
+
 ==== Commit Signature
 
 [options="header"]
@@ -657,7 +683,7 @@ a Git Hook in order to not disturb interactive rebase workflows.
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| true    | error    | excludes: `["\\.", "\\?", "\\!"]`
+| true    | error    | excludes: `["\\!", "\\.", "\\?"]`
 |===
 
 Ensures commit subjects are suffixed consistently. The exclude list _is_ case sensitive and prevents
@@ -665,6 +691,24 @@ the use of punctuation. This is handy when coupled with a tool, like
 link:https://alchemists.io/projects/milestoner[Milestoner], which automates project milestone
 releases.
 
+==== Commit Subject Word Repeat
+
+[options="header"]
+|===
+| Enabled | Severity
+| true    | error
+|===
+
+Ensures commit subjects don't contain repeated words. Example:
+
+....
+# Disallowed
+Added specs specs
+
+# Allowed
+Added specs
+....
+
 ==== Commit Trailer Collaborator Capitalization
 
 [options="header"]
@@ -695,28 +739,28 @@ Ensures collaborator email address is valid for commit trailer.
 
 ....
 # Disallowed
-Co-Authored-By: River Tam <invalid>
+Co-authored-by: River Tam <invalid>
 
 # Allowed
-Co-Authored-By: River Tam <river@firefly.com>
+Co-authored-by: River Tam <river@firefly.com>
 ....
 
 ==== Commit Trailer Collaborator Key
 
 [options="header"]
 |===
-| Enabled | Severity | Defaults
-| true   | error    | includes: `["Co-Authored-By"]`
+| Enabled | Severity
+| true   | error
 |===
 
 Ensures collaborator trailer key is correct format.
 
 ....
 # Disallowed
-Co-authored-by: River Tam <river@firefly.com>
+co-authored-by: River Tam <river@firefly.com>
 
 # Allowed
-Co-Authored-By: River Tam <river@firefly.com>
+Co-authored-by: River Tam <river@firefly.com>
 ....
 
 ==== Commit Trailer Collaborator Name
@@ -731,10 +775,10 @@ Ensures collaborator name consists of, at least, a first and last name. Example:
 
 ....
 # Disallowed
-Co-Authored-By: River <river@firefly.com>
+Co-authored-by: River <river@firefly.com>
 
 # Allowed
-Co-Authored-By: River Tam <river@firefly.com>
+Co-authored-by: River Tam <river@firefly.com>
 ....
 
 ==== Commit Trailer Duplicate
@@ -749,30 +793,30 @@ Ensures commit trailer keys are not duplicated. Example:
 
 ....
 # Disallowed
-Co-Authored-By: Shepherd Derrial Book <shepherd@firefly.com>
-Co-Authored-By: Shepherd Derrial Book <shepherd@firefly.com>
+Co-authored-by: Shepherd Derrial Book <shepherd@firefly.com>
+Co-authored-by: Shepherd Derrial Book <shepherd@firefly.com>
 
 # Allowed
-Co-Authored-By: Malcolm Reynolds <malcolm@firefly.com>
-Co-Authored-By: Shepherd Derrial Book <shepherd@firefly.com>
+Co-authored-by: Malcolm Reynolds <malcolm@firefly.com>
+Co-authored-by: Shepherd Derrial Book <shepherd@firefly.com>
 ....
 
 ==== Commit Trailer Format Key
 
 [options="header"]
 |===
-| Enabled | Severity | Defaults
-| true    | error    | includes: `["Format"]`
+| Enabled | Severity
+| true    | error
 |===
 
 Ensures format trailer key is correct format.
 
 ....
 # Disallowed
-format: ASCII
+format: markdown
 
 # Allowed
-Format: ASCII
+Format: markdown
 ....
 
 ==== Commit Trailer Format Value
@@ -780,25 +824,25 @@ Format: ASCII
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| true    | error    | includes: `["ASCII", "Markdown"]`
+| true    | error    | includes: `["asciidoc", "markdown"]`
 |===
 
 Ensures format trailer value is a valid value.
 
 ....
 # Disallowed
-Format: Plain
+Format: plain
 
 # Allowed
-Format: ASCII
+Format: asciidoc
 ....
 
 ==== Commit Trailer Issue Key
 
 [options="header"]
 |===
-| Enabled | Severity | Defaults
-| true    | error    | includes: `["Issue"]`
+| Enabled | Severity
+| true    | error
 |===
 
 Ensures issue trailer key is correct format.
@@ -829,6 +873,100 @@ Issue: 123+45
 Issue: 123
 ....
 
+==== Commit Trailer Milestone Key
+
+[options="header"]
+|===
+| Enabled | Severity
+| true    | error
+|===
+
+Ensures milestone trailer key is correct format.
+
+....
+# Disallowed
+milestone: patch
+
+# Allowed
+Milestone: patch
+....
+
+==== Commit Trailer Milestone Value
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | includes: `[major, minor, patch]`
+|===
+
+Ensures milestone trailer value is correct format for link:https://semver.org[semantic versioning] purposes.
+
+....
+# Disallowed
+Milestone: bogus
+
+# Allowed
+Milestone: patch
+....
+
+==== Commit Trailer Order
+
+[options="header"]
+|===
+| Enabled | Severity
+| true    | error
+|===
+
+Ensures milestone trailers are alphabetically sorted.
+
+....
+# Disallowed
+Issue: 123
+Milestone: patch
+Format: asciidoc
+
+# Allowed
+Format: asciidoc
+Issue: 123
+Milestone: patch
+....
+
+==== Commit Trailer Reviewer Key
+
+[options="header"]
+|===
+| Enabled | Severity
+| true    | error
+|===
+
+Ensures reviewer trailer key is correct format.
+
+....
+# Disallowed
+reviewer: tana
+
+# Allowed
+Reviewer: tana
+....
+
+==== Commit Trailer Reviewer Value
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | includes: `[clickup, github, jira, linear, shortcut, tana]`
+|===
+
+Ensures reviewer trailer value is correct format for linking/referencing the code review system.
+
+....
+# Disallowed
+Reviewer: bogus
+
+# Allowed
+Reviewer: tana
+....
+
 ==== Commit Trailer Signer Capitalization
 
 [options="header"]
@@ -841,10 +979,10 @@ Ensures commit signer trailer name is properly capitalized.
 
 ....
 # Disallowed
-Signed-By: jayne cobb
+Signed-off-by: jayne cobb
 
 # Allowed
-Signed-By: Jayne Cobb
+Signed-off-by: Jayne Cobb
 ....
 
 ==== Commit Trailer Signer Email
@@ -859,28 +997,28 @@ Ensures commit signer trailer email is properly capitalized.
 
 ....
 # Disallowed
-Signed-By: Jayne Cobb <invalid>
+Signed-off-by: Jayne Cobb <invalid>
 
 # Allowed
-Signed-By: Jayne Cobb <jcobb@firefly.com>
+Signed-off-by: Jayne Cobb <jcobb@firefly.com>
 ....
 
 ==== Commit Trailer Signer Key
 
 [options="header"]
 |===
-| Enabled | Severity | Defaults
-| true    | error    | includes: `["Signed-By"]`
+| Enabled | Severity
+| true    | error
 |===
 
 Ensures signer trailer key is correct format.
 
 ....
 # Disallowed
-signed-by: Jayne Cobb
+signed-off-by: Jayne Cobb
 
 # Allowed
-Signed-By: Jayne Cobb
+Signed-off-by: Jayne Cobb
 ....
 
 ==== Commit Trailer Signer Name
@@ -895,28 +1033,28 @@ Ensures signer name consists of, at least, a first and last name.
 
 ....
 # Disallowed
-Signed-By: Jayne
+Signed-off-by: Jayne
 
 # Allowed
-Signed-By: Jayne Cobb
+Signed-off-by: Jayne Cobb
 ....
 
 ==== Commit Trailer Tracker Key
 
 [options="header"]
 |===
-| Enabled | Severity | Defaults
-| true    | error    | includes: `["Tracker"]`
+| Enabled | Severity
+| true    | error
 |===
 
 Ensures tracker trailer key is correct format.
 
 ....
 # Disallowed
-tracker: Linear
+tracker: linear
 
 # Allowed
-Tracker: Linear
+Tracker: linear
 ....
 
 ==== Commit Trailer Tracker Value
@@ -1065,8 +1203,7 @@ This gem automatically configures itself for known CI build servers (see below f
 have a build server that is not listed, please log an issue or provide an implementation with
 support.
 
-Calculation of commits is done by reviewing all commits made on the feature branch since branching
-from `main`.
+Calculation of commits is done by analyzing all feature branch commits ahead of the default branch (i.e. "main"). In other words, `git log --oneline main..your_feature_branch`.
 
 ==== link:https://circleci.com[Circle CI]
 
@@ -1092,9 +1229,9 @@ jobs:
       image: ruby:latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
         with:
-          fetch-depth: '0'
+          fetch-depth: 0
           ref: ${{github.head_ref}}
       - name: Install
         run: gem install git-lint

data/git-lint.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "git-lint"
-  spec.version = "6.2.1"
+  spec.version = "7.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/git-lint"
@@ -22,20 +22,20 @@ Gem::Specification.new do |spec|
   spec.signing_key = Gem.default_key_path
   spec.cert_chain = [Gem.default_cert_path]
 
-  spec.required_ruby_version = [">= 3.2", "<= 3.3"]
-  spec.add_dependency "cogger", "~> 0.12"
-  spec.add_dependency "core", "~> 0.1"
+  spec.required_ruby_version = "~> 3.3"
+  spec.add_dependency "cogger", "~> 0.15"
+  spec.add_dependency "core", "~> 1.0"
   spec.add_dependency "dry-container", "~> 0.11"
   spec.add_dependency "dry-monads", "~> 1.6"
   spec.add_dependency "dry-schema", "~> 1.13"
-  spec.add_dependency "etcher", "~> 0.2"
-  spec.add_dependency "gitt", "~> 2.0"
-  spec.add_dependency "infusible", "~> 2.2"
-  spec.add_dependency "refinements", "~> 11.0"
-  spec.add_dependency "runcom", "~> 10.0"
-  spec.add_dependency "sod", "~> 0.0"
-  spec.add_dependency "spek", "~> 2.0"
-  spec.add_dependency "tone", "~> 0.3"
+  spec.add_dependency "etcher", "~> 1.0"
+  spec.add_dependency "gitt", "~> 3.2"
+  spec.add_dependency "infusible", "~> 3.0"
+  spec.add_dependency "refinements", "~> 12.0"
+  spec.add_dependency "runcom", "~> 11.0"
+  spec.add_dependency "sod", "~> 0.4"
+  spec.add_dependency "spek", "~> 3.0"
+  spec.add_dependency "tone", "~> 1.0"
   spec.add_dependency "zeitwerk", "~> 2.6"
 
   spec.bindir = "exe"