git-lint 10.3.0 → 11.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0579e354abdcbf74f13138b3380d58268cfe02847d140a798bb76ac91fbd6fbf'
-  data.tar.gz: 1da76b63c393d595dfcc3ff01115bf1f36d51393b34469858bb29aed2cecfec3
+  metadata.gz: 1a398440d3a796edbf3a4b4d1e93feb848e5ce64b5e7ba5cfdc88125232467f5
+  data.tar.gz: 1ffb61ebc1605e237c633325b11421c508e06419e0c93ffa89a7820592177f39
 SHA512:
-  metadata.gz: c913dfcd75ba482a13fada4abadbbc05f2a532300bd4f3447ac8afe101e7eeeda5c4f721cdfe9f4018fe2982bf74de462b42736c8c65661ae348e7e3b2a44e6f
-  data.tar.gz: 7d2a6722730e23745716ae618d306a8931dc3361c7b58f389eb721b4ba15d1369c76514505723eebcb572f949ef8ac0b3b0e2ad5d860cec7adc44fea58603a9c
+  metadata.gz: 4bc2132df51e741c9c4b6486d66dc15e3e6939404d0131af907f3c7a4300bed0f649e9afe7ef0a3d38f4576736c0eb74ab2d166340ff9a652f4e6ea3a084fb5e
+  data.tar.gz: 6971baf71e978c16005c37b02bc7ff3550e5177b4b630919ae3df7938775d8e5c518ff1107f1aa3c49def405cae42d043a1c150ce886d8585beb9ca568096613

data/README.adoc

@@ -142,6 +142,9 @@ commits:
     paragraph_capitalization:
       enabled: true
       severity: error
+    paragraph_new_line:
+      enabled: true
+      severity: error
     phrase:
       enabled: true
       severity: error
@@ -228,6 +231,11 @@ commits:
     collaborator_email:
       enabled: true
       severity: error
+      excludes:
+        - "agent@"
+        - "codex@"
+        - "copilot@"
+        - "noreply"
     collaborator_key:
       enabled: true
       severity: error
@@ -258,6 +266,7 @@ commits:
     milestone_key:
       enabled: true
       severity: error
+      mandatory: true
     milestone_value:
       enabled: true
       severity: error
@@ -525,6 +534,26 @@ Curabitur eleifend wisi iaculis ipsum.
 * link:https://docs.asciidoctor.org/asciidoc/latest/macros/links[Links]
 * link:https://docs.asciidoctor.org/asciidoc/latest/macros/xref[Cross references]
 
+==== Commit Body Paragraph New Line
+
+[options="header"]
+|===
+| Enabled | Severity | Defaults
+| true    | error    | none
+|===
+
+Ensures each paragraph of the commit body doesn't use excessive new lines. This allows paragraphs to grow/shrink based on screen size for improved readability.
+
+....
+# Disallowed
+Pellentque morbi-trist sentus et netus
+et malesuada fames ac turpis egestas.
+Vestibulum tortor quam.
+
+# Allowed
+Pellentque morbi-trist sentus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam.
+....
+
 ==== Commit Body Phrase
 
 [options="header"]
@@ -561,7 +590,7 @@ and provides the missing spec to ensure this doesn't happen again.
 Ensures a minimum number of lines are present within the commit body. Lines with empty characters
 (i.e. whitespace, carriage returns, etc.) are considered to be empty.
 
-Automatically ignores _fixup!_ commits as they are not meant to have bodies.
+Automatically ignores _fixup!_ directives because they are not meant to have bodies.
 
 ==== Commit Body Tracker Shorthand
 
@@ -646,7 +675,7 @@ Added documentation
 Added documentation
 ....
 
-Automatically ignores _amend!_, _fixup!_, or _squash!_ commit prefixes.
+Automatically ignores _amend!_, _fixup!_, and _squash!_ directives.
 
 ==== Commit Subject Length
 
@@ -661,7 +690,7 @@ lenient than the link:http://tbaggery.com/2008/04/19/a-note-about-git-commit-mes
 rule] as it gives one the ability to formulate a more descriptive subject line without being too
 wordy or suffer being word wrapped.
 
-Automatically ignores _fixup!_ or _squash!_ commit prefixes when calculating subject length.
+Automatically ignores _amend!_, _fixup!_, and _squash!_ directives.
 
 ==== Commit Subject Prefix
 
@@ -708,8 +737,7 @@ Each prefix is delimited by a space which is the default setting but can be cust
 Whatever you choose for a delimiter will not affect Git's special bang prefixes as described in the
 tip below.
 
-💡 This analyzer automatically ignores _amend!_, _fixup!_, or _squash!_ commit prefixes when used as
-a Git Hook in order to not disturb interactive rebase workflows.
+Automatically ignores _amend!_, _fixup!_, and _squash!_ directives.
 
 ==== Commit Subject Suffix
 
@@ -765,7 +793,7 @@ Shepherd Derrial Book
 [options="header"]
 |===
 | Enabled | Severity | Defaults
-| true    | error    | none
+| true    | error    | excludes: (see configuration)
 |===
 
 Ensures collaborator email address is valid for commit trailer.
@@ -774,6 +802,9 @@ Ensures collaborator email address is valid for commit trailer.
 # Disallowed
 Co-authored-by: River Tam <invalid>
 
+# Disallowed
+Co-authored-by: LLM <agent@slopware.io>
+
 # Allowed
 Co-authored-by: River Tam <river@firefly.com>
 ....
@@ -910,13 +941,15 @@ Issue: 123
 
 [options="header"]
 |===
-| Enabled | Severity
-| true    | error
+| Enabled | Severity | Manditory
+| true    | error    | true
 |===
 
-Ensures milestone trailer key is correct format.
+Ensures milestone trailer key is present and in correct format.
 
 ....
+# Disallowed (missing)
+
 # Disallowed
 milestone: patch
 
@@ -924,6 +957,10 @@ milestone: patch
 Milestone: patch
 ....
 
+This key is mandatory by default which means the key must always be present unless the repository is unpublished (i.e. has no origin). When the repository is unpublished, this gives you the freedom to release your initial version (i.e. 0.0.0) without this trailer. Once published, you'll need the trailer. To make the key optional, set mandatory to `false`.
+
+Automatically ignores _amend!_, _fixup!_, and _squash!_ directives.
+
 ==== Commit Trailer Milestone Value
 
 [options="header"]

data/git-lint.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "git-lint"
-  spec.version = "10.3.0"
+  spec.version = "11.0.1"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/git-lint"
@@ -30,7 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-monads", "~> 1.9"
   spec.add_dependency "dry-schema", "~> 1.15"
   spec.add_dependency "etcher", "~> 4.3"
-  spec.add_dependency "gitt", "~> 5.0"
+  spec.add_dependency "gitt", "~> 5.3"
   spec.add_dependency "infusible", "~> 5.0"
   spec.add_dependency "refinements", "~> 14.0"
   spec.add_dependency "runcom", "~> 13.0"

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Git
+  module Lint
+    module Analyzers
+      # Analyzes proper capitalization of commit body paragraphs.
+      class CommitBodyParagraphNewLine < Abstract
+        PATTERN = /
+          \n      # New line.
+          (?!     # Negative lookahead start.
+          \s{1,}  # Indentation.
+          |       # Or.
+          \s*     # Optional whitespace.
+          \#      # Comment character.
+          )       # Negative lookahead end.
+        /mx
+
+        def initialize(commit, pattern: PATTERN, **)
+          super(commit, **)
+          @pattern = pattern
+        end
+
+        def valid? = invalids.empty?
+
+        def issue
+          return {} if valid?
+
+          {
+            hint: "Avoid unnecessary new lines.",
+            lines: affected_lines
+          }
+        end
+
+        private
+
+        attr_reader :pattern
+
+        def affected_lines
+          invalids.each.with_object [] do |line, lines|
+            lines << self.class.build_issue_line(commit.body_lines.index(line[/.+/]), line)
+          end
+        end
+
+        def invalids
+          @invalids ||= commit.body_paragraphs.grep pattern
+        end
+      end
+    end
+  end
+end

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

@@ -17,15 +17,23 @@ module Git
           return {} if valid?
 
           {
-            hint: %(Email must follow name and use format: "<name@server.domain>".),
+            hint: %(Use format: "<name@server.domain>". Avoid: #{filter_list.to_usage}.),
             lines: affected_commit_trailers
           }
         end
 
         protected
 
+        def load_filter_list
+          Kit::FilterList.new settings.commits_trailer_collaborator_email_excludes
+        end
+
         def invalid_line? trailer
-          email = parser.call(trailer.value).email
+          value = trailer.value
+
+          return true if value.match?(/.*#{Regexp.union filter_list}.*/)
+
+          email = parser.call(value).email
           trailer.key.match?(setting.pattern) && !validator.call(email)
         end
 

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

@@ -5,15 +5,15 @@ module Git
     module Analyzers
       # Analyzes commit trailer milestone key usage.
       class CommitTrailerMilestoneKey < Abstract
-        include Dependencies[setting: "trailers.milestone"]
+        include Dependencies[:git, setting: "trailers.milestone"]
 
-        def valid? = affected_commit_trailers.empty?
+        def valid? = !mandatory? && affected_commit_trailers.empty?
 
         def issue
           return {} if valid?
 
           {
-            hint: "Use: #{filter_list.to_usage}.",
+            hint: "#{hint_prefix}: #{filter_list.to_usage}.",
             lines: affected_commit_trailers
           }
         end
@@ -27,6 +27,20 @@ module Git
             key.match?(setting.pattern) && !key.match?(/\A#{Regexp.union filter_list}\Z/)
           end
         end
+
+        private
+
+        def mandatory?
+          return false if commit.directive?
+
+          missing = commit.trailers.none? { it.key == setting.name }
+
+          settings.commits_trailer_milestone_key_mandatory && git.origin? && missing
+        end
+
+        def hint_prefix
+          settings.commits_trailer_milestone_key_mandatory ? "Use (manditory)" : "Use"
+        end
       end
     end
   end

data/lib/git/lint/analyzers/commits/sole.rb

@@ -20,6 +20,7 @@ module Git
             Analyzers::CommitBodyLeadingLine,
             Analyzers::CommitBodyLineLength,
             Analyzers::CommitBodyParagraphCapitalization,
+            Analyzers::CommitBodyParagraphNewLine,
             Analyzers::CommitBodyPhrase,
             Analyzers::CommitBodyPresence,
             Analyzers::CommitBodyTrackerShorthand,

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

@@ -32,6 +32,8 @@ module Git
         required(:commits_body_line_length_maximum).filled :integer
         required(:commits_body_paragraph_capitalization_enabled).filled :bool
         required(:commits_body_paragraph_capitalization_severity).filled :string
+        required(:commits_body_paragraph_new_line_enabled).filled :bool
+        required(:commits_body_paragraph_new_line_severity).filled :string
         required(:commits_body_phrase_enabled).filled :bool
         required(:commits_body_phrase_severity).filled :string
         required(:commits_body_phrase_excludes).array :string
@@ -64,6 +66,7 @@ module Git
         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_email_excludes).array :string
         required(:commits_trailer_collaborator_key_enabled).filled :bool
         required(:commits_trailer_collaborator_key_severity).filled :string
         required(:commits_trailer_collaborator_name_enabled).filled :bool
@@ -83,6 +86,7 @@ module Git
         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_key_mandatory).filled :bool
         required(:commits_trailer_milestone_value_enabled).filled :bool
         required(:commits_trailer_milestone_value_severity).filled :string
         required(:commits_trailer_milestone_value_includes).array :string

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

@@ -39,6 +39,9 @@ commits:
     paragraph_capitalization:
       enabled: true
       severity: error
+    paragraph_new_line:
+      enabled: true
+      severity: error
     phrase:
       enabled: true
       severity: error
@@ -125,6 +128,11 @@ commits:
     collaborator_email:
       enabled: true
       severity: error
+      excludes:
+        - "agent@"
+        - "codex@"
+        - "copilot@"
+        - "noreply"
     collaborator_key:
       enabled: true
       severity: error
@@ -155,6 +163,7 @@ commits:
     milestone_key:
       enabled: true
       severity: error
+      mandatory: true
     milestone_value:
       enabled: true
       severity: error

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

@@ -27,6 +27,8 @@ module Git
                          :commits_body_line_length_maximum,
                          :commits_body_paragraph_capitalization_enabled,
                          :commits_body_paragraph_capitalization_severity,
+                         :commits_body_paragraph_new_line_enabled,
+                         :commits_body_paragraph_new_line_severity,
                          :commits_body_phrase_enabled,
                          :commits_body_phrase_severity,
                          :commits_body_phrase_excludes,
@@ -59,6 +61,7 @@ module Git
                          :commits_trailer_collaborator_capitalization_severity,
                          :commits_trailer_collaborator_email_enabled,
                          :commits_trailer_collaborator_email_severity,
+                         :commits_trailer_collaborator_email_excludes,
                          :commits_trailer_collaborator_key_enabled,
                          :commits_trailer_collaborator_key_severity,
                          :commits_trailer_collaborator_name_enabled,
@@ -78,6 +81,7 @@ module Git
                          :commits_trailer_issue_value_includes,
                          :commits_trailer_milestone_key_enabled,
                          :commits_trailer_milestone_key_severity,
+                         :commits_trailer_milestone_key_mandatory,
                          :commits_trailer_milestone_value_enabled,
                          :commits_trailer_milestone_value_severity,
                          :commits_trailer_milestone_value_includes,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-lint
 version: !ruby/object:Gem::Version
-  version: 10.3.0
+  version: 11.0.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -125,14 +125,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: infusible
   requirement: !ruby/object:Gem::Requirement
@@ -256,6 +256,7 @@ files:
 - lib/git/lint/analyzers/commit_body_leading_line.rb
 - lib/git/lint/analyzers/commit_body_line_length.rb
 - lib/git/lint/analyzers/commit_body_paragraph_capitalization.rb
+- lib/git/lint/analyzers/commit_body_paragraph_new_line.rb
 - lib/git/lint/analyzers/commit_body_phrase.rb
 - lib/git/lint/analyzers/commit_body_presence.rb
 - lib/git/lint/analyzers/commit_body_tracker_shorthand.rb
@@ -346,7 +347,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.12
+rubygems_version: 4.0.13
 specification_version: 4
 summary: A command line interface for linting Git commits.
 test_files: []