git-lint 6.2.0 → 7.0.0

data/lib/git/lint/analyzers/commit_trailer_reviewer_value.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes commit trailer reviewer value.
+      class CommitTrailerReviewerValue < Abstract
+        include Import[setting: "trailers.reviewer"]
+
+        def valid? = affected_commit_trailers.empty?
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Use: #{filter_list.to_usage "or"}.",
+            lines: affected_commit_trailers
+          }
+        end
+
+        protected
+
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_trailer_reviewer_value_includes
+        end
+
+        def invalid_line? trailer
+          trailer.key.match?(setting.pattern) && !trailer.value.match?(value_pattern)
+        end
+
+        def value_pattern = /\A#{Regexp.union filter_list}\Z/
+      end
+    end
+  end
+end

data/lib/git/lint/analyzers/commit_trailer_signer_capitalization.rb

@@ -6,7 +6,7 @@ module Git
       # Analyzes commit trailer signer name capitalization.
       class CommitTrailerSignerCapitalization < Abstract
         include Import[
-          pattern: "trailers.signer",
+          setting: "trailers.signer",
           parser: "parsers.person",
           validator: "validators.capitalization"
         ]
@@ -26,7 +26,7 @@ module Git
 
         def invalid_line? trailer
           parser.call(trailer.value).then do |person|
-            trailer.key.match?(pattern) && !validator.call(person.name)
+            trailer.key.match?(setting.pattern) && !validator.call(person.name)
           end
         end
       end

data/lib/git/lint/analyzers/commit_trailer_signer_email.rb

@@ -6,9 +6,8 @@ module Git
       # Analyzes commit trailer signer email address format.
       class CommitTrailerSignerEmail < Abstract
         include Import[
-          pattern: "trailers.signer",
+          setting: "trailers.signer",
           parser: "parsers.person",
-          sanitizer: "sanitizers.email",
           validator: "validators.email"
         ]
 
@@ -26,8 +25,8 @@ module Git
         protected
 
         def invalid_line? trailer
-          email = sanitizer.call parser.call(trailer.value).email
-          trailer.key.match?(pattern) && !validator.call(email)
+          email = parser.call(trailer.value).email
+          trailer.key.match?(setting.pattern) && !validator.call(email)
         end
 
         private

data/lib/git/lint/analyzers/commit_trailer_signer_key.rb

@@ -5,7 +5,7 @@ module Git
     module Analyzers
       # Analyzes commit trailer signer key usage.
       class CommitTrailerSignerKey < Abstract
-        include Import[pattern: "trailers.signer"]
+        include Import[setting: "trailers.signer"]
 
         def valid? = affected_commit_trailers.empty?
 
@@ -13,7 +13,7 @@ module Git
           return {} if valid?
 
           {
-            hint: "Use format: #{filter_list.to_hint}.",
+            hint: "Use format: #{filter_list.to_usage}.",
             lines: affected_commit_trailers
           }
         end
@@ -21,12 +21,12 @@ module Git
         protected
 
         def load_filter_list
-          Kit::FilterList.new configuration.commits_trailer_signer_key_includes
+          Kit::FilterList.new setting.name
         end
 
         def invalid_line? trailer
           trailer.key.then do |key|
-            key.match?(pattern) && !key.match?(/\A#{Regexp.union filter_list.to_regexp}\Z/)
+            key.match?(setting.pattern) && !key.match?(/\A#{Regexp.union filter_list}\Z/)
           end
         end
       end

data/lib/git/lint/analyzers/commit_trailer_signer_name.rb

@@ -6,7 +6,7 @@ module Git
       # Analyzes commit trailer signer name construction.
       class CommitTrailerSignerName < Abstract
         include Import[
-          pattern: "trailers.signer",
+          setting: "trailers.signer",
           parser: "parsers.person",
           validator: "validators.name"
         ]
@@ -26,7 +26,7 @@ module Git
 
         def invalid_line? trailer
           parser.call(trailer.value).then do |person|
-            trailer.key.match?(pattern) && !validator.call(person.name, minimum:)
+            trailer.key.match?(setting.pattern) && !validator.call(person.name, minimum:)
           end
         end
 

data/lib/git/lint/analyzers/commit_trailer_tracker_key.rb

@@ -5,7 +5,7 @@ module Git
     module Analyzers
       # Analyzes commit trailer tracker key usage.
       class CommitTrailerTrackerKey < Abstract
-        include Import[pattern: "trailers.tracker"]
+        include Import[setting: "trailers.tracker"]
 
         def valid? = affected_commit_trailers.empty?
 
@@ -13,20 +13,18 @@ module Git
           return {} if valid?
 
           {
-            hint: "Use format: #{filter_list.to_hint}.",
+            hint: "Use format: #{filter_list.to_usage}.",
             lines: affected_commit_trailers
           }
         end
 
         protected
 
-        def load_filter_list
-          Kit::FilterList.new configuration.commits_trailer_tracker_key_includes
-        end
+        def load_filter_list = Kit::FilterList.new setting.name
 
         def invalid_line? trailer
           trailer.key.then do |key|
-            key.match?(pattern) && !key.match?(/\A#{Regexp.union filter_list.to_regexp}\Z/)
+            key.match?(setting.pattern) && !key.match?(/\A#{Regexp.union filter_list}\Z/)
           end
         end
       end

data/lib/git/lint/analyzers/commit_trailer_tracker_value.rb

@@ -5,7 +5,7 @@ module Git
     module Analyzers
       # Analyzes commit trailer tracker value.
       class CommitTrailerTrackerValue < Abstract
-        include Import[pattern: "trailers.tracker"]
+        include Import[setting: "trailers.tracker"]
 
         def valid? = affected_commit_trailers.empty?
 
@@ -13,7 +13,7 @@ module Git
           return {} if valid?
 
           {
-            hint: "Use format: #{filter_list.to_hint}.",
+            hint: "Use format: #{filter_list.to_usage}.",
             lines: affected_commit_trailers
           }
         end
@@ -25,10 +25,10 @@ module Git
         end
 
         def invalid_line? trailer
-          trailer.key.match?(pattern) && !trailer.value.match?(value_pattern)
+          trailer.key.match?(setting.pattern) && !trailer.value.match?(value_pattern)
         end
 
-        def value_pattern = /\A#{Regexp.union filter_list.to_regexp}\Z/
+        def value_pattern = /\A#{Regexp.union filter_list}\Z/
       end
     end
   end

data/lib/git/lint/commits/{systems → hosts}/circle_ci.rb

@@ -3,8 +3,8 @@
 module Git
   module Lint
     module Commits
-      module Systems
-        # Provides Circle CI build environment feature branch information.
+      module Hosts
+        # Provides Circle CI feature branch information.
         class CircleCI
           include Git::Lint::Import[:git]
 

data/lib/git/lint/commits/{systems → hosts}/container.rb

@@ -5,8 +5,8 @@ require "dry/container"
 module Git
   module Lint
     module Commits
-      module Systems
-        # Provides a single container with application and system specific dependencies.
+      module Hosts
+        # Provides a single container with application and host specific dependencies.
         module Container
           extend Dry::Container::Mixin
 

data/lib/git/lint/commits/{systems → hosts}/git_hub_action.rb

@@ -3,8 +3,8 @@
 module Git
   module Lint
     module Commits
-      module Systems
-        # Provides GitHub Action build environment feature branch information.
+      module Hosts
+        # Provides GitHub Action feature branch information.
         class GitHubAction
           include Git::Lint::Import[:git]
 

data/lib/git/lint/commits/{systems → hosts}/import.rb

@@ -5,7 +5,7 @@ require "infusible"
 module Git
   module Lint
     module Commits
-      module Systems
+      module Hosts
         Import = Infusible.with Container
       end
     end

data/lib/git/lint/commits/{systems → hosts}/local.rb

@@ -3,8 +3,8 @@
 module Git
   module Lint
     module Commits
-      module Systems
-        # Provides local build environment feature branch information.
+      module Hosts
+        # Provides local feature branch information.
         class Local
           include Git::Lint::Import[:git]
 

data/lib/git/lint/commits/{systems → hosts}/netlify_ci.rb

@@ -3,8 +3,8 @@
 module Git
   module Lint
     module Commits
-      module Systems
-        # Provides Netlify CI build environment feature branch information.
+      module Hosts
+        # Provides Netlify CI feature branch information.
         class NetlifyCI
           include Git::Lint::Import[:git, :environment]
 

data/lib/git/lint/commits/loader.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require "refinements/strings"
+require "refinements/string"
 
 module Git
   module Lint
     module Commits
-      # Automatically detects and loads system.
+      # Automatically detects and loads host.
       class Loader
-        include Systems::Import[
+        include Hosts::Import[
           :circle_ci,
           :git,
           :git_hub_action,
@@ -16,18 +16,18 @@ module Git
           :environment
         ]
 
-        using ::Refinements::Strings
+        using Refinements::String
 
         def call
           message = "Invalid repository. Are you within a Git repository?"
           fail Errors::Base, message unless git.exist?
 
-          load_system.call
+          host.call
         end
 
         private
 
-        def load_system
+        def host
           if key? "CIRCLECI" then circle_ci
           elsif key? "GITHUB_ACTIONS" then git_hub_action
           elsif key? "NETLIFY" then netlify_ci

data/lib/git/lint/configuration/contract.rb

@@ -16,15 +16,15 @@ module Git
         required(:commits_author_name_enabled).filled :bool
         required(:commits_author_name_severity).filled :string
         required(:commits_author_name_minimum).filled :integer
-        required(:commits_body_bullet_enabled).filled :bool
-        required(:commits_body_bullet_severity).filled :string
-        required(:commits_body_bullet_excludes).array :string
         required(:commits_body_bullet_capitalization_enabled).filled :bool
         required(:commits_body_bullet_capitalization_severity).filled :string
         required(:commits_body_bullet_capitalization_includes).array :string
         required(:commits_body_bullet_delimiter_enabled).filled :bool
         required(:commits_body_bullet_delimiter_severity).filled :string
         required(:commits_body_bullet_delimiter_includes).array :string
+        required(:commits_body_bullet_only_enabled).filled :bool
+        required(:commits_body_bullet_only_severity).filled :string
+        required(:commits_body_bullet_only_includes).array :string
         required(:commits_body_leading_line_enabled).filled :bool
         required(:commits_body_leading_line_severity).filled :string
         required(:commits_body_line_length_enabled).filled :bool
@@ -38,9 +38,8 @@ module Git
         required(:commits_body_presence_enabled).filled :bool
         required(:commits_body_presence_severity).filled :string
         required(:commits_body_presence_minimum).filled :integer
-        required(:commits_body_single_bullet_enabled).filled :bool
-        required(:commits_body_single_bullet_severity).filled :string
-        required(:commits_body_single_bullet_includes).array :string
+        required(:commits_body_word_repeat_enabled).filled :bool
+        required(:commits_body_word_repeat_severity).filled :string
         required(:commits_body_tracker_shorthand_enabled).filled :bool
         required(:commits_body_tracker_shorthand_severity).filled :string
         required(:commits_body_tracker_shorthand_excludes).array :string
@@ -57,13 +56,14 @@ module Git
         required(:commits_subject_suffix_enabled).filled :bool
         required(:commits_subject_suffix_severity).filled :string
         required(:commits_subject_suffix_excludes).array :string
+        required(:commits_subject_word_repeat_enabled).filled :bool
+        required(:commits_subject_word_repeat_severity).filled :string
         required(:commits_trailer_collaborator_capitalization_enabled).filled :bool
         required(:commits_trailer_collaborator_capitalization_severity).filled :string
         required(:commits_trailer_collaborator_email_enabled).filled :bool
         required(:commits_trailer_collaborator_email_severity).filled :string
         required(:commits_trailer_collaborator_key_enabled).filled :bool
         required(:commits_trailer_collaborator_key_severity).filled :string
-        required(:commits_trailer_collaborator_key_includes).array :string
         required(:commits_trailer_collaborator_name_enabled).filled :bool
         required(:commits_trailer_collaborator_name_severity).filled :string
         required(:commits_trailer_collaborator_name_minimum).filled :integer
@@ -71,29 +71,37 @@ module Git
         required(:commits_trailer_duplicate_severity).filled :string
         required(:commits_trailer_format_key_enabled).filled :bool
         required(:commits_trailer_format_key_severity).filled :string
-        required(:commits_trailer_format_key_includes).array :string
         required(:commits_trailer_format_value_enabled).filled :bool
         required(:commits_trailer_format_value_severity).filled :string
         required(:commits_trailer_format_value_includes).array :string
         required(:commits_trailer_issue_key_enabled).filled :bool
         required(:commits_trailer_issue_key_severity).filled :string
-        required(:commits_trailer_issue_key_includes).array :string
         required(:commits_trailer_issue_value_enabled).filled :bool
         required(:commits_trailer_issue_value_severity).filled :string
         required(:commits_trailer_issue_value_includes).array :string
+        required(:commits_trailer_milestone_key_enabled).filled :bool
+        required(:commits_trailer_milestone_key_severity).filled :string
+        required(:commits_trailer_milestone_value_enabled).filled :bool
+        required(:commits_trailer_milestone_value_severity).filled :string
+        required(:commits_trailer_milestone_value_includes).array :string
+        required(:commits_trailer_order_enabled).filled :bool
+        required(:commits_trailer_order_severity).filled :string
+        required(:commits_trailer_reviewer_key_enabled).filled :bool
+        required(:commits_trailer_reviewer_key_severity).filled :string
+        required(:commits_trailer_reviewer_value_enabled).filled :bool
+        required(:commits_trailer_reviewer_value_severity).filled :string
+        required(:commits_trailer_reviewer_value_includes).array :string
         required(:commits_trailer_signer_capitalization_enabled).filled :bool
         required(:commits_trailer_signer_capitalization_severity).filled :string
         required(:commits_trailer_signer_email_enabled).filled :bool
         required(:commits_trailer_signer_email_severity).filled :string
         required(:commits_trailer_signer_key_enabled).filled :bool
         required(:commits_trailer_signer_key_severity).filled :string
-        required(:commits_trailer_signer_key_includes).array :string
         required(:commits_trailer_signer_name_enabled).filled :bool
         required(:commits_trailer_signer_name_severity).filled :string
         required(:commits_trailer_signer_name_minimum).filled :integer
         required(:commits_trailer_tracker_key_enabled).filled :bool
         required(:commits_trailer_tracker_key_severity).filled :string
-        required(:commits_trailer_tracker_key_includes).array :string
         required(:commits_trailer_tracker_value_enabled).filled :bool
         required(:commits_trailer_tracker_value_severity).filled :string
         required(:commits_trailer_tracker_value_includes).array :string

data/lib/git/lint/configuration/defaults.yml

@@ -11,22 +11,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
@@ -47,6 +49,7 @@ commits:
         - "along the lines"
         - "at this moment in time"
         - "basically"
+        - "blacklist"
         - "each and every one"
         - "everyone knows"
         - "fact of the matter"
@@ -61,6 +64,7 @@ commits:
         - "really"
         - "simply"
         - "things being equal"
+        - "whitelist"
         - "would like to"
         - "\\beasy\\b"
         - "\\bjust\\b"
@@ -71,11 +75,6 @@ commits:
       enabled: true
       severity: warn
       minimum: 1
-    single_bullet:
-      enabled: true
-      severity: error
-      includes:
-        - "\\-"
     tracker_shorthand:
       enabled: true
       severity: error
@@ -83,6 +82,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
@@ -110,6 +112,9 @@ commits:
         - "\\."
         - "\\?"
         - "\\!"
+    word_repeat:
+      enabled: true
+      severity: error
   trailer:
     collaborator_capitalization:
       enabled: true
@@ -120,8 +125,6 @@ commits:
     collaborator_key:
       enabled: true
       severity: error
-      includes:
-        - Co-Authored-By
     collaborator_name:
       enabled: true
       severity: error
@@ -132,24 +135,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
@@ -159,8 +184,6 @@ commits:
     signer_key:
       enabled: true
       severity: error
-      includes:
-        - Signed-By
     signer_name:
       enabled: true
       severity: error
@@ -168,8 +191,6 @@ commits:
     tracker_key:
       enabled: true
       severity: error
-      includes:
-        - Tracker
     tracker_value:
       enabled: true
       severity: error

data/lib/git/lint/configuration/model.rb

@@ -11,15 +11,15 @@ module Git
                           :commits_author_name_enabled,
                           :commits_author_name_severity,
                           :commits_author_name_minimum,
-                          :commits_body_bullet_enabled,
-                          :commits_body_bullet_severity,
-                          :commits_body_bullet_excludes,
                           :commits_body_bullet_capitalization_enabled,
                           :commits_body_bullet_capitalization_severity,
                           :commits_body_bullet_capitalization_includes,
                           :commits_body_bullet_delimiter_enabled,
                           :commits_body_bullet_delimiter_severity,
                           :commits_body_bullet_delimiter_includes,
+                          :commits_body_bullet_only_enabled,
+                          :commits_body_bullet_only_severity,
+                          :commits_body_bullet_only_includes,
                           :commits_body_leading_line_enabled,
                           :commits_body_leading_line_severity,
                           :commits_body_line_length_enabled,
@@ -33,9 +33,8 @@ module Git
                           :commits_body_presence_enabled,
                           :commits_body_presence_severity,
                           :commits_body_presence_minimum,
-                          :commits_body_single_bullet_enabled,
-                          :commits_body_single_bullet_severity,
-                          :commits_body_single_bullet_includes,
+                          :commits_body_word_repeat_enabled,
+                          :commits_body_word_repeat_severity,
                           :commits_body_tracker_shorthand_enabled,
                           :commits_body_tracker_shorthand_severity,
                           :commits_body_tracker_shorthand_excludes,
@@ -52,13 +51,14 @@ module Git
                           :commits_subject_suffix_enabled,
                           :commits_subject_suffix_severity,
                           :commits_subject_suffix_excludes,
+                          :commits_subject_word_repeat_enabled,
+                          :commits_subject_word_repeat_severity,
                           :commits_trailer_collaborator_capitalization_enabled,
                           :commits_trailer_collaborator_capitalization_severity,
                           :commits_trailer_collaborator_email_enabled,
                           :commits_trailer_collaborator_email_severity,
                           :commits_trailer_collaborator_key_enabled,
                           :commits_trailer_collaborator_key_severity,
-                          :commits_trailer_collaborator_key_includes,
                           :commits_trailer_collaborator_name_enabled,
                           :commits_trailer_collaborator_name_severity,
                           :commits_trailer_collaborator_name_minimum,
@@ -66,29 +66,37 @@ module Git
                           :commits_trailer_duplicate_severity,
                           :commits_trailer_format_key_enabled,
                           :commits_trailer_format_key_severity,
-                          :commits_trailer_format_key_includes,
                           :commits_trailer_format_value_enabled,
                           :commits_trailer_format_value_severity,
                           :commits_trailer_format_value_includes,
                           :commits_trailer_issue_key_enabled,
                           :commits_trailer_issue_key_severity,
-                          :commits_trailer_issue_key_includes,
                           :commits_trailer_issue_value_enabled,
                           :commits_trailer_issue_value_severity,
                           :commits_trailer_issue_value_includes,
+                          :commits_trailer_milestone_key_enabled,
+                          :commits_trailer_milestone_key_severity,
+                          :commits_trailer_milestone_value_enabled,
+                          :commits_trailer_milestone_value_severity,
+                          :commits_trailer_milestone_value_includes,
+                          :commits_trailer_order_enabled,
+                          :commits_trailer_order_severity,
+                          :commits_trailer_reviewer_key_enabled,
+                          :commits_trailer_reviewer_key_severity,
+                          :commits_trailer_reviewer_value_enabled,
+                          :commits_trailer_reviewer_value_severity,
+                          :commits_trailer_reviewer_value_includes,
                           :commits_trailer_signer_capitalization_enabled,
                           :commits_trailer_signer_capitalization_severity,
                           :commits_trailer_signer_email_enabled,
                           :commits_trailer_signer_email_severity,
                           :commits_trailer_signer_key_enabled,
                           :commits_trailer_signer_key_severity,
-                          :commits_trailer_signer_key_includes,
                           :commits_trailer_signer_name_enabled,
                           :commits_trailer_signer_name_severity,
                           :commits_trailer_signer_name_minimum,
                           :commits_trailer_tracker_key_enabled,
                           :commits_trailer_tracker_key_severity,
-                          :commits_trailer_tracker_key_includes,
                           :commits_trailer_tracker_value_enabled,
                           :commits_trailer_tracker_value_severity,
                           :commits_trailer_tracker_value_includes

data/lib/git/lint/configuration/trailer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Configuration
+      # Defines trailer configuration as a subset of the primary configuration.
+      Trailer = Data.define :name, :pattern
+    end
+  end
+end