git-lint 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a9c8435e0b05c4beaf7129ff10a7e4e794374031fa1d1707234e27de5d3f815
-  data.tar.gz: fc01c78223f9fdbc1f458214d037e79d5c05245cfdcd2815e5c8d90583464322
+  metadata.gz: 6f84ea345a2766e79b70b6b4f6a596def5a0ddcc4ba86954b754459fb88f7b8c
+  data.tar.gz: 1f6c09a430050ec57cacb4942347200bc83b0bc6a268939eaafbbbacb88d284d
 SHA512:
-  metadata.gz: 3dac7a51483e7f92f72616226350611316aa0d2e2b9669080ebbfc5aba76b4df432b316d1a4e7e4a17f308dbe3b24d4891f81656c6c0189153ad1d6b9fed098f
-  data.tar.gz: 03e9445f0624f688b7bbb1cf11987cc56c31ebb52878a459b4ec26b6d9dd2994624b3602323e1ad8b3fb551803a2f9fd187214430a1831c93590391ec4a63108
+  metadata.gz: 79448218359e860c42656a0b8e9e114fbc13eae838d493566b5bd6a2f0e499ccb4de5a94073770a954fe7b768244bb8bb0fc28fc4732ba1ac76855c755fd628f
+  data.tar.gz: d46f1b0c3ad4ffdc9655358c02dc0929970d7b6f2c88b4889ec0849de899a052c8359d7d6c199bb07af0045c7be3d1459a6b8efbff208574624761d8641e5627

data/README.adoc

@@ -18,8 +18,11 @@ image::https://travis-ci.org/bkuhlmann/git-lint.svg?branch=main[Travis CI Status
 [link=https://app.netlify.com/sites/git-lint/deploys]
 image::https://api.netlify.com/api/v1/badges/7e23b422-3412-4e7f-b654-65c0417a0b1f/deploy-status[Netlify CI Status]
 
-A command line interface for linting Git commits. Ensures you maintain a clean, easy to read,
-debuggable, and maintainable project history.
+Git Lint is a command line interface for linting Git commits by ensuring you maintain a clean, easy
+to read, debuggable, and maintainable project history. Having a consistent commit history leads to
+improved code reviews and is a perfect companion to tools like
+link:https://www.alchemists.io/projects/milestoner[Milestoner] for versioning and producing
+automated release notes of your deploys.
 
 toc::[]
 
@@ -109,7 +112,8 @@ require "git/lint/rake/setup"
 
 Now, when running `bundle exec rake -T`, you'll see `git_lint` included in the list.
 
-If you need a concrete example, check out the link:Rakefile[Rakefile] of this project for details.
+If you need a concrete example, check out the
+link:https://github.com/bkuhlmann/git-lint/blob/main/Rakefile[Rakefile] of this project for details.
 
 === Default Branch
 
@@ -731,12 +735,12 @@ Automatically ignores _fixup!_ or _squash!_ commit prefixes when calculating sub
 | true    | error    | includes: (see below)
 |===
 
-Ensures the commit subject uses consistent prefixes that explain _what_ is being committed. The
+Ensures each commit subject uses consistent prefixes that explain _what_ is being committed. The
 `includes` are _case sensitive_ and default to the following prefixes:
 
 * *Fixed* - Identifies what was fixed. The commit should be as small as possible and consist of
-  changes to implementation and spec only. In some cases this might be a single line or file change.
-  The important point is the change is applied to existing code which corrects behavior that wasn't
+  changes to implementation and spec only. In some cases this might be a single line change. The
+  important point is the change is applied to existing code which corrects behavior that wasn't
   properly implemented earlier.
 * *Removed* - Identifies what was removed. The commit should be as small as possible and consist
   only of removed lines/files from the existing implementation. This might also mean breaking
@@ -754,14 +758,17 @@ Ensures the commit subject uses consistent prefixes that explain _what_ is being
   implementation behavior or corresponding specs because, if that happens, then one of the other
   four prefixes is what you want to use instead.
 
-In practice, using a prefix other than what has been detailed above to explain _what_ is being
-committed is never needed. These prefixes are not only short and easy to remember but also have the
+In practice, it is quite rare to need a prefix other than what has been detailed above to explain
+_what_ is being committed. These prefixes are not only short and easy to remember but also have the
 added benefit of categorizing the commits for building release notes, change logs, etc. This becomes
-handy when coupled with another tool, link:https://www.alchemists.io/projects/milestoner[Milestoner],
-for producing consistent project milestones and Git tag histories.
+handy when coupled with another tool,
+link:https://www.alchemists.io/projects/milestoner[Milestoner], for producing consistent project
+milestones and Git tag histories. For a deeper dive on subject prefixes and good commit messages in
+general, please read about link:https://www.alchemists.io/articles/git_commit_anatomy[commit anatomy
+] to learn more. 🎉
 
-💡 Automatically ignores _amend!_, _fixup!_, or _squash!_ commit prefixes when used as a Git Hook in
-order to not disturb interactive rebase workflows.
+💡 This analyzer automatically ignores _amend!_, _fixup!_, or _squash!_ commit prefixes when used as
+a Git Hook in order to not disturb interactive rebase workflows.
 
 === Commit Subject Suffix
 
@@ -899,8 +906,9 @@ worth considering:
   Submodules can accomplish.
 * Avoid using link:https://git-lfs.github.com[Git LFS] for tracking binary artifacts/resources.
   These files are not meant for version control and lead to large repositories that are time
-  consuming to clone/deploy. Use storage managers, like link:https://aws.amazon.com/s3[Amazon S3]
-  for example, that are better suited for binary assets that don't change often.
+  consuming to clone/deploy. Use storage managers, like link:https://aws.amazon.com/s3[Amazon S3] or
+  link:https://lakefs.io[LakeFS] for example, that are better suited for binary assets that don't
+  change often.
 
 === Security
 

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

@@ -17,7 +17,7 @@ module Git
         def valid?
           return true if commit.fixup?
 
-          valid_lines = commit.body_lines.reject { |line| line.match?(/^\s*$/) }
+          valid_lines = commit.body_lines.grep_v(/^\s*$/)
           valid_lines.size >= minimum
         end
 

data/lib/git/lint/cli.rb

@@ -78,7 +78,7 @@ module Git
         else
           help "--hook"
         end
-      rescue Errors::Base, GitPlus::Errors::Base => error
+      rescue Errors::Base, GitPlus::Error => error
         abort colorizer.red("#{Identity::LABEL}: #{error.message}")
       end
 

data/lib/git/lint/identity.rb

@@ -6,8 +6,8 @@ module Git
     module Identity
       NAME = "git-lint"
       LABEL = "Git Lint"
-      VERSION = "2.3.0"
-      VERSION_LABEL = "#{LABEL} #{VERSION}"
+      VERSION = "2.4.0"
+      VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
     end
   end
 end

data/lib/git/lint.rb

@@ -1,20 +1,50 @@
 # frozen_string_literal: true
 
-require "zeitwerk"
 require "git_plus"
-
-loader = Zeitwerk::Loader.new
-loader.inflector.inflect "cli" => "CLI",
-                         "sha" => "SHA",
-                         "circle_ci" => "CircleCI",
-                         "netlify_ci" => "NetlifyCI",
-                         "travis_ci" => "TravisCI"
-loader.push_dir "#{__dir__}/.."
-loader.ignore "#{__dir__}/lint/rake/setup.rb"
-loader.setup
-
-# Main namespace.
-module Git
-  module Lint
-  end
-end
+require "git/lint/identity"
+require "git/lint/refinements/strings"
+require "git/lint/errors/base"
+require "git/lint/errors/severity"
+require "git/lint/errors/sha"
+require "git/lint/kit/filter_list"
+require "git/lint/validators/email"
+require "git/lint/validators/name"
+require "git/lint/validators/capitalization"
+require "git/lint/parsers/trailers/collaborator"
+require "git/lint/branches/environments/local"
+require "git/lint/branches/environments/circle_ci"
+require "git/lint/branches/environments/git_hub_action"
+require "git/lint/branches/environments/netlify_ci"
+require "git/lint/branches/environments/travis_ci"
+require "git/lint/branches/feature"
+require "git/lint/analyzers/abstract"
+require "git/lint/analyzers/commit_author_capitalization"
+require "git/lint/analyzers/commit_author_email"
+require "git/lint/analyzers/commit_author_name"
+require "git/lint/analyzers/commit_body_bullet"
+require "git/lint/analyzers/commit_body_bullet_capitalization"
+require "git/lint/analyzers/commit_body_bullet_delimiter"
+require "git/lint/analyzers/commit_body_issue_tracker_link"
+require "git/lint/analyzers/commit_body_leading_line"
+require "git/lint/analyzers/commit_body_line_length"
+require "git/lint/analyzers/commit_body_paragraph_capitalization"
+require "git/lint/analyzers/commit_body_phrase"
+require "git/lint/analyzers/commit_body_presence"
+require "git/lint/analyzers/commit_body_single_bullet"
+require "git/lint/analyzers/commit_subject_length"
+require "git/lint/analyzers/commit_subject_prefix"
+require "git/lint/analyzers/commit_subject_suffix"
+require "git/lint/analyzers/commit_trailer_collaborator_capitalization"
+require "git/lint/analyzers/commit_trailer_collaborator_duplication"
+require "git/lint/analyzers/commit_trailer_collaborator_email"
+require "git/lint/analyzers/commit_trailer_collaborator_key"
+require "git/lint/analyzers/commit_trailer_collaborator_name"
+require "git/lint/collector"
+require "git/lint/reporters/lines/sentence"
+require "git/lint/reporters/lines/paragraph"
+require "git/lint/reporters/line"
+require "git/lint/reporters/style"
+require "git/lint/reporters/commit"
+require "git/lint/reporters/branch"
+require "git/lint/runner"
+require "git/lint/cli"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-lint
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-07-05 00:00:00.000000000 Z
+date: 2021-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git_plus
@@ -36,14 +36,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.4'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
@@ -100,20 +100,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
-- !ruby/object:Gem::Dependency
-  name: zeitwerk
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
 description:
 email:
 - brooke@alchemists.io
@@ -200,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.21
+rubygems_version: 3.2.28
 signing_key:
 specification_version: 4
 summary: A command line interface for linting Git commits.