git-lint 5.2.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 588bd293760045f8bffac98557e0b8bd084a8f20113735627c87c843a5ca9c23
-  data.tar.gz: 7870c61941155e7665e84c312e44128809dd14f1a4dbf6ef7a8e999c593d405d
+  metadata.gz: 5ffca289e0b59fadd72f484cacf157edd85858593f8c8c100f14c4fea847c81f
+  data.tar.gz: 262ecb9b537ca4e748f39ae2a1d5a874bdbf6bb2d944301a5de4d1eab8198866
 SHA512:
-  metadata.gz: 9a543e267cdc7ce41b0402b03e7d20b4ae1eb78c4d1f8443c8410cd7496717dfae49b978a2d0f7f25fecc9a048051f197b2b5732f1ca0f71ca64d03e40e6ce36
-  data.tar.gz: 2aa9fde18ca69c66a2131652719c33addd4761c48634777581ecb7a4f8a27ce17aa943a7a53f54e4004cce9db44249e7f7c721428a05f529f845015e8305345f
+  metadata.gz: d4e25d238b757637080e02a784a3d2df421fbf52633ca9f933e48bc2f7b8cd4f7d2e96c1c0acc190184bb058fa90d8e9984d131e0bd00cd55de4cfadfbba4298
+  data.tar.gz: b5a690ba1f82862963bb6c45de94933f514a94dc3f01fd2e439dc024f8383a74fb8d65824519bb06da997fa181c01dee1c6013b9f29600666d035cb2d6d0c8dd

data/README.adoc

@@ -53,19 +53,22 @@ gem install git-lint
 From the command line, type: `git-lint --help`
 
 ....
-USAGE:
-  -a, --analyze [options]                  Analyze current branch commits.
-  -c, --config ACTION                      Manage gem configuration. Actions: edit or view.
-  -h, --help                               Show this message.
-      --hook PATH                          Hook for analyzing unsaved commits.
-  -v, --version                            Show gem version.
-
-ANALYZE OPTIONS:
-      --sha HASH                           Analyze specific commit SHA.
+USAGE
+  git-lint [OPTIONS]
+  git-lint COMMAND [OPTIONS]
+
+OPTIONS
+  --hook PATH              Hook for analyzing unsaved commits.
+  -v, --version            Show version.
+  -h, --help [COMMAND]     Show this message.
+
+COMMANDS
+  config                   Manage configuration.
+                           Path is dynamic per current directory.
+  analyze                  Analyze branch or commit(s).
 ....
 
-To check if your Git commit history is clean, run: `git-lint --analyze`. It will exit with a failure
-if at least one issue with error severity is detected.
+To check if your Git commit history is clean, run: `git-lint analyze --branch`. It will exit with a failure if at least one issue with error severity is detected.
 
 This gem does not check commits on your default branch (i.e. `main`). This is intentional as you
 would, generally, not want to rewrite or fix commits on the `main` branch. This gem is best used on
@@ -80,7 +83,7 @@ git checkout -b test
 touch text.txt
 git add --all .
 git commit --message "This is a bogus commit message that is also terribly long and will word wrap"
-git-lint --analyze
+git-lint analyze --branch
 ----
 
 Output:
@@ -110,130 +113,185 @@ variables. The default configuration is:
 
 [source,yaml]
 ----
-: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_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_body_leading_line:
-    :enabled: false
-    :severity: :warn
-  :commit_body_line_length:
-    :enabled: true
-    :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: false
-    :severity: :warn
-    :minimum: 1
-  :commit_body_single_bullet:
-    :enabled: true
-    :severity: :error
-    :includes: "\\-"
-  :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_duplication:
-    :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
+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]+"
 ----
 
-Feel free to take this default configuration, modify, and save as your own custom
-`configuration.yml`.
-
 ==== Enablement
 
 By default, most analyzers are enabled. Accepted values are `true` or `false`. If you wish to
@@ -965,11 +1023,11 @@ Whenever you attempt to add a commit, Git Lint will check your commit for issues
 
 ===== Post Commit
 
-The _post-commit_ hook is possible via the `--analyze` command. Usage:
+The _post-commit_ hook is possible via the `analyze` command. Usage:
 
 [source,bash]
 ----
-git-lint --analyze --shas SHA
+git-lint analyze --commit SHA
 ----
 
 The _post-commit_ hook can be used multiple ways but, generally, you'll want to check the last
@@ -989,7 +1047,7 @@ if ! command -v git-lint > /dev/null; then
    exit 1
 fi
 
-git-lint --analyze --shas $(git log --pretty=format:%H -1)
+git-lint analyze --commit $(git log --pretty=format:%H -1)
 ----
 
 Whenever a commit has been saved, this script will run Git Lint to check for issues.

data/git-lint.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "git-lint"
-  spec.version = "5.2.0"
+  spec.version = "6.0.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/git-lint"
@@ -23,16 +23,19 @@ Gem::Specification.new do |spec|
   spec.cert_chain = [Gem.default_cert_path]
 
   spec.required_ruby_version = "~> 3.2"
-  spec.add_dependency "cogger", "~> 0.5"
-  spec.add_dependency "core", "~> 0.1.0"
+  spec.add_dependency "cogger", "~> 0.10"
+  spec.add_dependency "core", "~> 0.1"
   spec.add_dependency "dry-container", "~> 0.11"
   spec.add_dependency "dry-monads", "~> 1.6"
-  spec.add_dependency "gitt", "~> 1.1"
-  spec.add_dependency "infusible", "~> 1.0"
-  spec.add_dependency "refinements", "~> 10.0"
-  spec.add_dependency "runcom", "~> 9.0"
-  spec.add_dependency "spek", "~> 1.0"
-  spec.add_dependency "tone", "~> 0.1"
+  spec.add_dependency "dry-schema", "~> 1.13"
+  spec.add_dependency "etcher", "~> 0.2"
+  spec.add_dependency "gitt", "~> 2.0"
+  spec.add_dependency "infusible", "~> 2.0"
+  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 "zeitwerk", "~> 2.6"
 
   spec.bindir = "exe"

data/lib/git/lint/analyzer.rb

@@ -72,22 +72,20 @@ module Git
         commits.value_or([]).map { |commit| analyze commit }
       end
 
-      def analyze commit
-        settings.map { |setting| load_analyzer commit, setting.id }
-                .select(&:enabled?)
-                .map { |analyzer| collector.add analyzer }
+      def analyze(commit) = enabled.map { |id| collector.add load_analyzer(commit, id) }
+
+      # :reek:FeatureEnvy
+      def enabled
+        configuration.to_h
+                     .select { |key, value| key.end_with?("enabled") && value == true }
+                     .keys
+                     .map { |key| key.to_s.sub!("commits_", "commit_").delete_suffix! "_enabled" }
       end
 
       def load_analyzer commit, id
         analyzers.find { |analyzer| analyzer.id == id }
-                 .then do |analyzer|
-                   fail Errors::Base, "Invalid analyzer detected: #{id}." unless analyzer
-
-                   analyzer.new commit
-                 end
+                 .then { |analyzer| analyzer.new commit }
       end
-
-      def settings = configuration.analyzers
     end
   end
 end

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

@@ -12,10 +12,10 @@ module Git
 
         using ::Refinements::Strings
 
-        LEVELS = %i[warn error].freeze
+        LEVELS = %w[warn error].freeze
         BODY_OFFSET = 3
 
-        def self.id = to_s.delete_prefix("Git::Lint::Analyzers").snakecase.to_sym
+        def self.id = to_s.delete_prefix!("Git::Lint::Analyzers").snakecase
 
         def self.label = to_s.delete_prefix("Git::Lint::Analyzers").titleize
 
@@ -29,12 +29,9 @@ module Git
           @filter_list = load_filter_list
         end
 
-        def enabled? = settings.enabled
-
         def severity
-          settings.severity.tap do |level|
-            fail Errors::Severity, level unless LEVELS.include? level
-          end
+          configuration.public_send("#{self.class.id}_severity".sub("commit_", "commits_"))
+                       .tap { |level| fail Errors::Severity, level unless LEVELS.include? level }
         end
 
         def valid?
@@ -43,9 +40,9 @@ module Git
 
         def invalid? = !valid?
 
-        def warning? = invalid? && severity == :warn
+        def warning? = invalid? && severity == "warn"
 
-        def error? = invalid? && severity == :error
+        def error? = invalid? && severity == "error"
 
         def issue
           fail NotImplementedError, "The `##{__method__}` method must be implemented."
@@ -77,8 +74,6 @@ module Git
         def invalid_line? _line
           fail NotImplementedError, "The `.#{__method__}` method must be implemented."
         end
-
-        def settings = configuration.find_setting(self.class.id)
       end
     end
   end

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

@@ -17,7 +17,7 @@ module Git
 
         private
 
-        def minimum = settings.minimum
+        def minimum = configuration.commits_author_name_minimum
       end
     end
   end

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

@@ -18,7 +18,9 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.excludes)
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_body_bullet_excludes
+        end
 
         # :reek:FeatureEnvy
         def invalid_line? line

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

@@ -18,7 +18,9 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.includes)
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_body_bullet_capitalization_includes
+        end
 
         def invalid_line? line
           line.match?(/\A\s*#{Regexp.union filter_list.to_regexp}\s[[:lower:]]+/)

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

@@ -18,7 +18,9 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.includes)
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_body_bullet_delimiter_includes
+        end
 
         def invalid_line?(line) = line.match?(/\A\s*#{pattern}(?!(#{pattern}|\s)).+\Z/)
 

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

@@ -22,7 +22,7 @@ module Git
 
         private
 
-        def maximum = settings.maximum
+        def maximum = configuration.commits_body_line_length_maximum
       end
     end
   end

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

@@ -18,7 +18,9 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.excludes)
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_body_phrase_excludes
+        end
 
         def invalid_line? line
           line.downcase.match? Regexp.new(

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

@@ -14,7 +14,7 @@ module Git
           valid_lines.size >= minimum
         end
 
-        def minimum = settings.minimum
+        def minimum = configuration.commits_body_presence_minimum
 
         def issue
           return {} if valid?

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

@@ -18,7 +18,9 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.includes)
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_body_single_bullet_includes
+        end
 
         def invalid_line?(line) = line.match?(/\A#{Regexp.union filter_list.to_regexp}\s+/)
       end

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

@@ -18,7 +18,9 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.excludes)
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_body_tracker_shorthand_excludes
+        end
 
         def invalid_line?(line) = line.match?(/.*#{Regexp.union filter_list.to_regexp}.*/)
       end

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

@@ -15,7 +15,9 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.includes)
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_signature_includes
+        end
       end
     end
   end

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

@@ -15,7 +15,7 @@ module Git
 
         private
 
-        def maximum = settings.maximum
+        def maximum = configuration.commits_subject_length_maximum
       end
     end
   end

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

@@ -21,14 +21,16 @@ module Git
         protected
 
         def load_filter_list
-          settings.includes
-                  .map { |prefix| "#{prefix}#{settings.delimiter}" }
-                  .then { |list| Kit::FilterList.new list }
+          configuration.commits_subject_prefix_includes
+                       .map { |prefix| "#{prefix}#{delimiter}" }
+                       .then { |list| Kit::FilterList.new list }
         end
 
         def locally_prefixed? = !ci? && commit.prefix?
 
         def ci? = environment["CI"] == "true"
+
+        def delimiter = configuration.commits_subject_prefix_delimiter
       end
     end
   end

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

@@ -19,7 +19,9 @@ module Git
 
         protected
 
-        def load_filter_list = Kit::FilterList.new(settings.excludes)
+        def load_filter_list
+          Kit::FilterList.new configuration.commits_subject_suffix_excludes
+        end
       end
     end
   end