CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+### v3.8.0 (2018-08-06)
+- Add CapitalizeSubject config option to warn on WIPlikes
+
+### v3.7.0 (2017-01-07)
+- Run via Bundler if available
+
+### v3.6.0 (2016-11-18)
+- Disable WIP check by default
+
+### v3.5.0 (2016-04-05)
+- All validations are enabled on all branches by default
+
+### v3.4.0 (2015-12-08)
+- Skip capitalization check for autosquash commits
+
 ### v3.3.0 (2015-10-10)
 - Add support for custom validators
 

README.md

@@ -14,7 +14,7 @@ foobar foobar foobar foobar foobar foobar foobar foobar foobar foobar foobar
 2: Error: Second line must be blank.
 3: Error: Lines should be <= 72 chars. (76)
 
-Force commit? [y/n/e] ▊
+Commit anyway? [y/n/e] ▊
 ```
 
 ## Prerequisites
@@ -39,8 +39,8 @@ This creates a `.git/hooks/commit-msg` script which will automatically check you
 * **Tense**: Message must use imperative present tense: "Fix bug" and not "Fixed bug" or "Fixes bug."
 * **Subject Period**: Do not end your subject line with a period.
 * **Capitalize Subject**: Begin all subject lines with a capital letter.
-* **WIP**: Do not commit WIPs to shared branches.
-* **Frat House**: No frat house commit messages in shared branches.
+* **Frat House**: No offensive content.
+* **WIP**: Do not commit WIPs to shared branches (disabled by default)
 
 ## Configuration
 
@@ -61,12 +61,11 @@ Validators/SubjectPeriod:
   Enabled: true
 Validators/CapitalizeSubject:
   Enabled: true
-Validators/Wip:
-  Enabled:
-    - master
+  WarnOnWiplikes: true
 Validators/Frathouse:
-  Enabled:
-    - master
+  Enabled: true
+Validators/Wip:
+  Enabled: false
 ```
 
 The `Enabled` property accepts multiple formats:
@@ -75,10 +74,10 @@ The `Enabled` property accepts multiple formats:
 # true/false to enable/disable the validation (branch agnostic)
 Validators/Foo:
   Enabled: false
-# Array of String/Regex matching each branch for which it's enabled
+# Array of String or Regex matching each branch it's enabled on
 Validators/Bar:
   Enabled:
-    - master
+    - main
     - !ruby/regexp /\Afoo.+bar/
 ```
 
@@ -98,6 +97,19 @@ module FitCommit
     end
   end
 end
+
+# A validator can also validate the commit message as a whole:
+module FitCommit
+  module Validators
+    class MyCustomValidator < Base
+      def validate(lines)
+        if lines.none? { |line| line.text =~ /#\d+/ }
+          add_warning(lines.last.lineno, "Related issue not referenced.")
+        end
+      end
+    end
+  end
+end
 ```
 
 `Require` the file and enable the validator in your config:
@@ -145,6 +157,21 @@ To copy your default hooks into existing repos:
 $ git init
 ```
 
+### How can I run this standalone, like part of a CI process?
+
+Fit Commit can be run outside of a Git hook context with a simple shell script:
+
+```sh
+$ export GIT_BRANCH_NAME=branch_name
+$ export COMMIT_MESSAGE_PATH=path/to/message
+# Using Bundler
+$ bundle exec ruby -e 'require "fit_commit"; FitCommit.run'
+# Not using Bundler
+$ rbenv exec ruby -rrubygems -e 'require "fit_commit"; FitCommit.run'
+```
+
+It exits with an error code if any errors are present, which will fail a build if it's part of a CI run.
+
 ### Who decided these rules?
 Fit Commit aims to enforce *community standards*. The two influential guides are:
 
@@ -163,4 +190,6 @@ Author: [Mike Foley](https://github.com/m1foley)
 
 Inspiration taken from: [Tim Pope](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), [Jason Fox](https://gist.github.com/jasonrobertfox/8057124), [Addam Hardy](http://addamhardy.com/blog/2013/06/05/good-commit-messages-and-enforcing-them-with-git-hooks/), [pre-commit](https://github.com/jish/pre-commit)
 
-Similar projects: [gitlint](https://github.com/jorisroovers/gitlint) (written in Python)
+Similar projects:
+- [gitlint](https://github.com/jorisroovers/gitlint) (written in Python)
+- [fit-commit-js](https://www.npmjs.com/package/fit-commit-js) (Node.js package)

TODO.md

@@ -0,0 +1,3 @@
+# TODO
+
+- Ideas from: https://github.com/bkuhlmann/git-cop

fit-commit.gemspec

@@ -12,22 +12,20 @@ Gem::Specification.new do |gem|
   gem.description        = "A Git hook to validate your commit messages based on community standards."
   gem.files              = `git ls-files`.split("\n")
   gem.executables        = ["fit-commit"]
-  gem.default_executable = "fit-commit"
   gem.test_files         = `git ls-files -- test/*`.split("\n")
   gem.require_paths      = ["lib"]
   gem.extra_rdoc_files   = ["README.md"]
   gem.rdoc_options       = ["--main", "README.md"]
 
   gem.post_install_message = <<-EOF
-    Thank you for installing Fit Commit!
-    Install the hook in each git repo you want to scan using:
+    Install Fit Commit hooks in each git repo you want to scan using:
 
     > fit-commit install
 
     Read more: https://github.com/m1foley/fit-commit#readme
   EOF
 
-  gem.add_dependency("swearjar", "~> 1.0")
-  gem.add_development_dependency("minitest", "~> 5.8")
-  gem.add_development_dependency("rake", "~> 10.4")
+  gem.add_dependency("swearjar", "~> 1.4")
+  gem.add_development_dependency("minitest", "~> 5.14")
+  gem.add_development_dependency("rake", "~> 13.0")
 end

lib/fit_commit/cli.rb

@@ -23,7 +23,7 @@ def help
       $stderr.puts "fit-commit v#{FitCommit::VERSION}"
       $stderr.puts "Usage: fit-commit install"
       $stderr.puts "Usage: fit-commit uninstall"
-      EXIT_CODE_FAILURE
+      EXIT_CODE_SUCCESS
     end
 
     def install

lib/fit_commit/configuration_loader.rb

@@ -2,47 +2,58 @@
 
 module FitCommit
   class ConfigurationLoader
-    def global_configuration
-      all_filepaths.each_with_object({}) do |filepath, config|
+    SYSTEM_FILEPATH = "/etc/fit_commit.yml"
+    LOCAL_FILEPATH = ".fit_commit.yml"
+
+    def initialize(filepaths)
+      self.filepaths = filepaths
+    end
+
+    def self.default_configuration
+      new(default_filepaths).configuration
+    end
+
+    def configuration
+      filepaths.each_with_object({}) do |filepath, config|
         config.merge!(read_config(filepath)) do |_key, oldval, newval|
           oldval.merge(newval)
         end
       end
     end
 
-    private
-
-    def all_filepaths
-      # sorted by increasing precedence
-      [default_filepath, system_filepath, user_filepath, config_filepath, local_filepath]
+    def self.default_filepaths
+      [
+        gem_default_filepath,
+        SYSTEM_FILEPATH,
+        user_filepath,
+        config_filepath,
+        LOCAL_FILEPATH
+      ]
     end
 
-    def default_filepath
+    def self.gem_default_filepath
       File.expand_path("../../../templates/config/fit_commit.default.yml", __FILE__)
     end
 
-    def system_filepath
-      "/etc/fit_commit.yml"
-    end
-
-    def user_filepath
+    def self.user_filepath
       File.join(ENV["HOME"], ".fit_commit.yml")
     end
 
-    def config_filepath
+    def self.config_filepath
       File.join(git_top_level, "config", "fit_commit.yml")
     end
 
-    def local_filepath
-      ".fit_commit.yml"
-    end
-
-    def git_top_level
+    def self.git_top_level
       top_level = `git rev-parse --show-toplevel`.chomp.strip
       fail "Git repo not found! Please submit a bug report." if top_level == ""
       top_level
     end
 
+    private
+
+    # sorted by increasing precedence
+    attr_accessor :filepaths
+
     def read_config(path)
       load_yaml(path).each_with_object({}) do |(key, value), config|
         translated_key = translate_config_key(key)

lib/fit_commit/message_parser.rb

@@ -2,6 +2,9 @@
 
 module FitCommit
   class MessageParser
+    GIT_VERBOSE_MARKER = "# ------------------------ >8 ------------------------"
+    COMMENT_REGEX = /\A#/
+
     attr_accessor :message_path
     def initialize(message_path)
       self.message_path = message_path
@@ -13,9 +16,6 @@ def lines
 
     private
 
-    GIT_VERBOSE_MARKER = "# ------------------------ >8 ------------------------"
-    COMMENT_REGEX = /\A#/
-
     def relevant_lines
       message_text.lines.each_with_object([]) do |line, relevant_lines|
         line.chomp!

lib/fit_commit/runner.rb

@@ -8,6 +8,7 @@ class Runner
 
     EXIT_CODE_ALLOW_COMMIT  = 0
     EXIT_CODE_REJECT_COMMIT = 1
+    DEFAULT_EDITOR = "vim"
 
     attr_accessor :message_path, :branch_name, :stderr, :stdin
     def initialize(message_path, branch_name, stderr = $stderr, stdin = $stdin)
@@ -51,7 +52,7 @@ def retry_on_user_edit
 
     def ask_force_commit
       return unless interactive?
-      stderr.print "\nForce commit? [y/n/e] "
+      stderr.print "\nCommit anyway? [y/n/e] "
       input = stdin.gets
       fail StartOverOnEditException if input =~ /e/i
       input =~ /y/i
@@ -105,8 +106,6 @@ def edit_message
       system(editor, message_path)
     end
 
-    DEFAULT_EDITOR = "vim"
-
     def editor
       editor = ENV["EDITOR"]
       editor = DEFAULT_EDITOR unless editor && editor != "none"

lib/fit_commit/validator_loader.rb

@@ -2,7 +2,6 @@
 
 module FitCommit
   class ValidatorLoader
-    attr_accessor :branch_name, :configuration
     def initialize(branch_name, configuration = load_configuration)
       self.branch_name = branch_name
       self.configuration = configuration
@@ -14,8 +13,10 @@ def validators
 
     private
 
+    attr_accessor :branch_name, :configuration
+
     def load_configuration
-      FitCommit::ConfigurationLoader.new.global_configuration
+      FitCommit::ConfigurationLoader.default_configuration
     end
 
     def all_validators

lib/fit_commit/validators/capitalize_subject.rb

@@ -3,11 +3,29 @@
 module FitCommit
   module Validators
     class CapitalizeSubject < Base
-      def validate_line(lineno, text)
-        if lineno == 1 && text[0] =~ /[[:lower:]]/
-          add_error(lineno, "Begin all subject lines with a capital letter.")
+      MESSAGE = "Begin all subject lines with a capital letter."
+      SINGLE_WORD = /\A\w+\z/
+      AUTOSQUASH = /\A(fixup|squash)! /
+
+      def validate(lines)
+        if lines[0].text =~ /\A[[:lower:]]/ && lines[0].text !~ AUTOSQUASH
+          if ignore_on_wiplikes? && wiplike?(lines)
+            add_warning(1, MESSAGE)
+          else
+            add_error(1, MESSAGE)
+          end
         end
       end
+
+      private
+
+      def wiplike?(lines)
+        lines[0].text =~ SINGLE_WORD && lines[1..-1].all?(&:empty?)
+      end
+
+      def ignore_on_wiplikes?
+        config.fetch("WarnOnWiplikes")
+      end
     end
   end
 end

lib/fit_commit/validators/frathouse.rb

@@ -6,7 +6,7 @@ module Validators
     class Frathouse < Base
       def validate_line(lineno, text)
         if Swearjar.default.profane?(text)
-          add_error(lineno, "No frat house commit messages in shared branches.")
+          add_error(lineno, "No frat house commit messages.")
         end
       end
     end

lib/fit_commit/validators/line_length.rb

@@ -3,28 +3,32 @@
 module FitCommit
   module Validators
     class LineLength < Base
+      MERGE_COMMIT = /\AMerge branch '[^']+' into ./
+      URL = %r{[a-z]+://}
+
       def validate_line(lineno, text)
-        if lineno == 1 && text.empty?
-          add_error(lineno, "Subject line cannot be blank.")
-        elsif lineno == 2 && !text.empty?
-          add_error(lineno, "Second line must be blank.")
-        elsif line_too_long?(text)
+        if lineno == 1
+          if text.empty?
+            add_error(lineno, "Subject line cannot be blank.")
+          elsif text !~ MERGE_COMMIT
+            if text.length > max_line_length
+              add_error(lineno, format("Lines should be <= %i chars. (%i)",
+                max_line_length, text.length))
+            elsif text.length > subject_warn_length
+              add_warning(lineno, format("Subject line should be <= %i chars. (%i)",
+                subject_warn_length, text.length))
+            end
+          end
+        elsif lineno == 2
+          unless text.empty?
+            add_error(lineno, "Second line must be blank.")
+          end
+        elsif text.length > max_line_length && !(allow_long_urls? && text =~ URL)
           add_error(lineno, format("Lines should be <= %i chars. (%i)",
             max_line_length, text.length))
-        elsif lineno == 1 && text.length > subject_warn_length
-          add_warning(lineno, format("Subject line should be <= %i chars. (%i)",
-            subject_warn_length, text.length))
         end
       end
 
-      def line_too_long?(text)
-        text.length > max_line_length && !(allow_long_urls? && contains_url?(text))
-      end
-
-      def contains_url?(text)
-        text =~ %r{[a-z]+://}
-      end
-
       def max_line_length
         config.fetch("MaxLineLength")
       end