git-lint 5.3.0 → 6.0.0

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

@@ -1,162 +1,177 @@
-:analyzers:
-  :commit_author_capitalization:
-    :enabled: true
-    :severity: :error
-  :commit_author_email:
-    :enabled: true
-    :severity: :error
-  :commit_author_name:
-    :enabled: true
-    :severity: :error
-    :minimum: 2
-  :commit_body_bullet:
-    :enabled: true
-    :severity: :error
-    :excludes:
-      - "\\*"
-      - "•"
-  :commit_body_bullet_capitalization:
-    :enabled: true
-    :severity: :error
-    :includes: "\\-"
-  :commit_body_bullet_delimiter:
-    :enabled: true
-    :severity: :error
-    :includes: "\\-"
-  :commit_body_leading_line:
-    :enabled: true
-    :severity: :warn
-  :commit_body_line_length:
-    :enabled: false
-    :severity: :error
-    :maximum: 72
-  :commit_body_paragraph_capitalization:
-    :enabled: true
-    :severity: :error
-  :commit_body_phrase:
-    :enabled: true
-    :severity: :error
-    :excludes:
-      - "absolutely"
-      - "actually"
-      - "all intents and purposes"
-      - "along the lines"
-      - "at this moment in time"
-      - "basically"
-      - "each and every one"
-      - "everyone knows"
-      - "fact of the matter"
-      - "furthermore"
-      - "however"
-      - "in due course"
-      - "in the end"
-      - "last but not least"
-      - "matter of fact"
-      - "obviously"
-      - "of course"
-      - "really"
-      - "simply"
-      - "things being equal"
-      - "would like to"
-      - "\\beasy\\b"
-      - "\\bjust\\b"
-      - "\\bquite\\b"
-      - "as\\sfar\\sas\\s.+\\sconcerned"
-      - "of\\sthe\\s(fact|opinion)\\sthat"
-  :commit_body_presence:
-    :enabled: true
-    :severity: :warn
-    :minimum: 1
-  :commit_body_single_bullet:
-    :enabled: true
-    :severity: :error
-    :includes: "\\-"
-  :commit_body_tracker_shorthand:
-    :enabled: true
-    :severity: :error
-    :excludes:
-      - "(f|F)ix(es|ed)?\\s\\#\\d+"
-      - "(c|C)lose(s|d)?\\s\\#\\d+"
-      - "(r|R)esolve(s|d)?\\s\\#\\d+"
-  :commit_signature:
-    :enabled: false
-    :severity: :error
-    :includes: Good
-  :commit_subject_length:
-    :enabled: true
-    :severity: :error
-    :maximum: 72
-  :commit_subject_prefix:
-    :enabled: true
-    :severity: :error
-    :delimiter: " "
-    :includes:
-      - Fixed
-      - Added
-      - Updated
-      - Removed
-      - Refactored
-  :commit_subject_suffix:
-    :enabled: true
-    :severity: :error
-    :excludes:
-      - "\\."
-      - "\\?"
-      - "\\!"
-  :commit_trailer_collaborator_capitalization:
-    :enabled: true
-    :severity: :error
-  :commit_trailer_collaborator_email:
-    :enabled: true
-    :severity: :error
-  :commit_trailer_collaborator_key:
-    :enabled: true
-    :severity: :error
-    :includes: Co-Authored-By
-  :commit_trailer_collaborator_name:
-    :enabled: true
-    :severity: :error
-    :minimum: 2
-  :commit_trailer_duplicate:
-    :enabled: true
-    :severity: :error
-  :commit_trailer_format_key:
-    :enabled: true
-    :severity: :error
-    :includes: Format
-  :commit_trailer_format_value:
-    :enabled: true
-    :severity: :error
-    :includes:
-      - ASCII
-      - Markdown
-  :commit_trailer_issue_key:
-    :enabled: true
-    :severity: :error
-    :includes: Issue
-  :commit_trailer_issue_value:
-    :enabled: true
-    :severity: :error
-    :includes: "[\\w-]+"
-  :commit_trailer_signer_capitalization:
-    :enabled: true
-    :severity: :error
-  :commit_trailer_signer_email:
-    :enabled: true
-    :severity: :error
-  :commit_trailer_signer_key:
-    :enabled: true
-    :severity: :error
-    :includes: Signed-By
-  :commit_trailer_signer_name:
-    :enabled: true
-    :severity: :error
-    :minimum: 2
-  :commit_trailer_tracker_key:
-    :enabled: true
-    :severity: :error
-    :includes: Tracker
-  :commit_trailer_tracker_value:
-    :enabled: true
-    :severity: :error
-    :includes: "[\\w\\-\\s]+"
+commits:
+  author:
+    capitalization:
+      enabled: true
+      severity: error
+    email:
+      enabled: true
+      severity: error
+    name:
+      enabled: true
+      severity: error
+      minimum: 2
+  body:
+    bullet:
+      enabled: true
+      severity: error
+      excludes:
+        - "\\*"
+        - "•"
+    bullet_capitalization:
+      enabled: true
+      severity: error
+      includes:
+        - "\\-"
+    bullet_delimiter:
+      enabled: true
+      severity: error
+      includes:
+        - "\\-"
+    leading_line:
+      enabled: true
+      severity: warn
+    line_length:
+      enabled: false
+      severity: error
+      maximum: 72
+    paragraph_capitalization:
+      enabled: true
+      severity: error
+    phrase:
+      enabled: true
+      severity: error
+      excludes:
+        - "absolutely"
+        - "actually"
+        - "all intents and purposes"
+        - "along the lines"
+        - "at this moment in time"
+        - "basically"
+        - "each and every one"
+        - "everyone knows"
+        - "fact of the matter"
+        - "furthermore"
+        - "however"
+        - "in due course"
+        - "in the end"
+        - "last but not least"
+        - "matter of fact"
+        - "obviously"
+        - "of course"
+        - "really"
+        - "simply"
+        - "things being equal"
+        - "would like to"
+        - "\\beasy\\b"
+        - "\\bjust\\b"
+        - "\\bquite\\b"
+        - "as\\sfar\\sas\\s.+\\sconcerned"
+        - "of\\sthe\\s(fact|opinion)\\sthat"
+    presence:
+      enabled: true
+      severity: warn
+      minimum: 1
+    single_bullet:
+      enabled: true
+      severity: error
+      includes:
+        - "\\-"
+    tracker_shorthand:
+      enabled: true
+      severity: error
+      excludes:
+        - "(f|F)ix(es|ed)?\\s\\#\\d+"
+        - "(c|C)lose(s|d)?\\s\\#\\d+"
+        - "(r|R)esolve(s|d)?\\s\\#\\d+"
+  signature:
+    enabled: false
+    severity: error
+    includes:
+      - Good
+  subject:
+    length:
+      enabled: true
+      severity: error
+      maximum: 72
+    prefix:
+      enabled: true
+      severity: error
+      delimiter: " "
+      includes:
+        - Fixed
+        - Added
+        - Updated
+        - Removed
+        - Refactored
+    suffix:
+      enabled: true
+      severity: error
+      excludes:
+        - "\\."
+        - "\\?"
+        - "\\!"
+  trailer:
+    collaborator_capitalization:
+      enabled: true
+      severity: error
+    collaborator_email:
+      enabled: true
+      severity: error
+    collaborator_key:
+      enabled: true
+      severity: error
+      includes:
+        - Co-Authored-By
+    collaborator_name:
+      enabled: true
+      severity: error
+      minimum: 2
+    duplicate:
+      enabled: true
+      severity: error
+    format_key:
+      enabled: true
+      severity: error
+      includes:
+        - Format
+    format_value:
+      enabled: true
+      severity: error
+      includes:
+        - ASCII
+        - Markdown
+    issue_key:
+      enabled: true
+      severity: error
+      includes:
+        - Issue
+    issue_value:
+      enabled: true
+      severity: error
+      includes:
+        - "[\\w-]+"
+    signer_capitalization:
+      enabled: true
+      severity: error
+    signer_email:
+      enabled: true
+      severity: error
+    signer_key:
+      enabled: true
+      severity: error
+      includes:
+        - Signed-By
+    signer_name:
+      enabled: true
+      severity: error
+      minimum: 2
+    tracker_key:
+      enabled: true
+      severity: error
+      includes:
+        - Tracker
+    tracker_value:
+      enabled: true
+      severity: error
+      includes:
+        - "[\\w\\-\\s]+"

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Configuration
+      # Defines configuration content as the primary source of truth for use throughout the gem.
+      Model = Data.define :commits_author_capitalization_enabled,
+                          :commits_author_capitalization_severity,
+                          :commits_author_email_enabled,
+                          :commits_author_email_severity,
+                          :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_leading_line_enabled,
+                          :commits_body_leading_line_severity,
+                          :commits_body_line_length_enabled,
+                          :commits_body_line_length_severity,
+                          :commits_body_line_length_maximum,
+                          :commits_body_paragraph_capitalization_enabled,
+                          :commits_body_paragraph_capitalization_severity,
+                          :commits_body_phrase_enabled,
+                          :commits_body_phrase_severity,
+                          :commits_body_phrase_excludes,
+                          :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_tracker_shorthand_enabled,
+                          :commits_body_tracker_shorthand_severity,
+                          :commits_body_tracker_shorthand_excludes,
+                          :commits_signature_enabled,
+                          :commits_signature_severity,
+                          :commits_signature_includes,
+                          :commits_subject_length_enabled,
+                          :commits_subject_length_severity,
+                          :commits_subject_length_maximum,
+                          :commits_subject_prefix_enabled,
+                          :commits_subject_prefix_severity,
+                          :commits_subject_prefix_delimiter,
+                          :commits_subject_prefix_includes,
+                          :commits_subject_suffix_enabled,
+                          :commits_subject_suffix_severity,
+                          :commits_subject_suffix_excludes,
+                          :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,
+                          :commits_trailer_duplicate_enabled,
+                          :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_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
+    end
+  end
+end

data/lib/git/lint/container.rb

@@ -2,23 +2,37 @@
 
 require "cogger"
 require "dry-container"
+require "etcher"
 require "gitt"
+require "runcom"
 require "spek"
 require "tone"
 
 module Git
   module Lint
+    # :nocov:
     # Provides a global gem container for injection into other objects.
     module Container
       extend Dry::Container::Mixin
 
-      register(:configuration) { Configuration::Loader.call }
+      register :configuration do
+        self[:defaults].add_loader(Etcher::Loaders::YAML.new(self[:xdg_config].active))
+                       .then { |registry| Etcher.call registry }
+      end
+
+      register :defaults do
+        Etcher::Registry.new(contract: Configuration::Contract, model: Configuration::Model)
+                        .add_loader(Etcher::Loaders::YAML.new(self[:defaults_path]))
+      end
+
+      register(:color) { Tone.new }
       register(:environment) { ENV }
       register(:git) { Gitt::Repository.new }
+      register(:defaults_path) { Pathname(__dir__).join("configuration/defaults.yml") }
+      register(:xdg_config) { Runcom::Config.new "git-lint/configuration.yml" }
       register(:specification) { Spek::Loader.call "#{__dir__}/../../../git-lint.gemspec" }
       register(:kernel) { Kernel }
       register(:logger) { Cogger.new formatter: :emoji }
-      register(:color) { Tone.new }
 
       namespace :trailers do
         register(:collaborator) { /\ACo.*Authored.*By.*\Z/i }

data/lib/git/lint/rake/register.rb

@@ -18,7 +18,7 @@ module Git
 
         def call
           desc "Run Git Lint"
-          task(:git_lint) { shell.call ["--analyze"] }
+          task(:git_lint) { shell.call %w[analyze --branch] }
         end
 
         private

data/lib/git/lint/reporters/style.rb

@@ -29,16 +29,16 @@ module Git
 
         def severity_suffix
           case analyzer.severity
-            when :warn then " Warning"
-            when :error then " Error"
+            when "warn" then " Warning"
+            when "error" then " Error"
             else ""
           end
         end
 
         def style
           case analyzer.severity
-            when :warn then :yellow
-            when :error then :red
+            when "warn" then :yellow
+            when "error" then :red
             else :white
           end
         end