fit-commit 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb4ffe45a0ad53675d49f2cd52490915a181cded
-  data.tar.gz: 0706dcac90051c43fb56ad9912833f5dfee28667
+  metadata.gz: aabcc0d7d9ae18205dc7f0ffc39b7b6bff65e031
+  data.tar.gz: d844c683caef5cbb416b386c8c59b0f59000dcb0
 SHA512:
-  metadata.gz: 149f64e1b74901d17697a54e5675aad9b7269f4a5016424a3fb144b88cc935a8fbfc87b98375a75d852724ad5899c251acd3b3bac5fd30c2286c7afad591d314
-  data.tar.gz: b22509e397f85f26bb3df60b697c49e7437f925eae05c6bb38e8f4e2f7a059196c2939062807b505f7d7efe98d0116a9a0659dfa0ede8943ffe199e2bc3b1c8a
+  metadata.gz: 9151e4ed2c5e082b43cdd7acbfd19ac11bf6829aba734f505f3402a96686414800c9a0c820d03a5812aa5ddb39b04841d1f8c9be6e9c2b48d97d98ce5245026a
+  data.tar.gz: 9fdc57be60a116531a48fd88aa5d1d7d0ff232d6b01b47a255390b25f99bcec7c92a8ded4b2c82aeb32656f0e629378723ff7494f4d185077e5080a6076fa7b3

data/README.md

@@ -1,3 +1,4 @@
+
 # Fit Commit
 
 A Git hook to validate your commit messages, based largely on Tim Pope's [authoritative guide](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
@@ -10,7 +11,7 @@ Adding a cool feature
 foobar foobar foobar,
 foobar foobar foobar foobar foobar foobar foobar foobar foobar foobar foobar
 
-1: Error: Message must use present imperative tense.
+1: Error: Message must use imperative present tense.
 2: Error: Second line must be blank.
 3: Error: Lines should be <= 72 chars. (76)
 
@@ -36,11 +37,38 @@ This creates a `.git/hooks/commit-msg` script which will automatically check you
 ## Validations
 
 * **Line Length**: All lines must be <= 72 chars (URLs excluded). First line should be <= 50 chars. Second line must be blank.
-* **Tense**: Message must use present imperative tense.
+* **Tense**: Message must use imperative present tense: "Fix bug" and not "Fixed bug" or "Fixes bug."
 * **Summary Period**: Do not end your summary with a period.
 * **WIP**: Do not commit WIPs to master.
 * **Frat House**: No frat house commit messages in master.
 
+
+## FAQ
+
+### Can Fit Commit run in all my repos without having to install it each time?
+First set your global Git template directory:
+
+```
+$ git config --global init.templatedir '~/.git_template'
+```
+
+Now you can copy the hooks you want installed in new repos by default:
+
+```
+# From a repo where Fit Commit is already installed
+$ cp .git/hooks/commit-msg ~/.git_templates/hooks/commit-msg
+```
+
+To copy your default hooks into existing repos:
+
+```
+$ git init
+```
+
+### Fit Commit is too opinionated for me. What can I do?
+Fit Commit aims to be useful to everyone. If you can suggest an improvement to make it useful to more people, please open a GitHub Issue or Pull Request.
+
+
 ## Credits
 
 Author: [Mike Foley](https://github.com/m1foley)

data/lib/fit-commit/validators/tense.rb

@@ -64,12 +64,12 @@ module FitCommit
       )
 
       def validate_line(lineno, text, _branch_name)
-        if lineno == 1 && wrong_tense?(text)
-          add_error(lineno, "Message must use present imperative tense.")
+        if lineno == 1 && starts_with_blacklisted_verb?(text)
+          add_error(lineno, "Message must use imperative present tense.")
         end
       end
 
-      def wrong_tense?(text)
+      def starts_with_blacklisted_verb?(text)
         first_word = text.split.first(2).detect { |w| w =~ /\A\w/ }
         first_word && VERB_BLACKLIST.include?(first_word.downcase)
       end

data/lib/fit-commit/version.rb

@@ -1,3 +1,3 @@
 module FitCommit
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/test/validators/tense_test.rb

@@ -8,7 +8,7 @@ describe FitCommit::Validators::Tense do
   let(:branch_name) { "anybranch" }
 
   describe "uses incorrect tense on first line" do
-    let(:commit_msg) { "Changed something\nhi" }
+    let(:commit_msg) { "Changed something" }
     it "has error" do
       validator.validate
       assert_equal 1, validator.errors[1].size
@@ -16,8 +16,26 @@ describe FitCommit::Validators::Tense do
     end
   end
 
+  describe "uses incorrect tense on first line" do
+    let(:commit_msg) { "[#ticketno] Changed something" }
+    it "has error" do
+      validator.validate
+      assert_equal 1, validator.errors[1].size
+      assert_empty validator.warnings
+    end
+  end
+
+  describe "has incorrect tense after the first word" do
+    let(:commit_msg) { "Document fixes to bug" }
+    it "does not have errors/warnings" do
+      validator.validate
+      assert_empty validator.errors
+      assert_empty validator.warnings
+    end
+  end
+
   describe "uses incorrect tense on a line other than first line" do
-    let(:commit_msg) { "hi\nChanged something" }
+    let(:commit_msg) { "Fix bug\n\nChanged something" }
     it "does not have errors/warnings" do
       validator.validate
       assert_empty validator.errors

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fit-commit
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Michael Foley
@@ -68,7 +68,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- TODO.txt
 - bin/fit-commit
 - fit-commit.gemspec
 - lib/fit-commit.rb

data/TODO.txt

@@ -1,4 +0,0 @@
-- Document adding fit-commit to ~/.git_template
-- Customize which are "business" branches (not just master)
-- Configuration to disable validations.
-- `fit-commit uninstall`