Merge pull request #5 from tommarshall/4-handle-autosquash-flags

Handle autosquash flags

Author: tommarshall

README.md

@@ -27,7 +27,7 @@ Offers an interactive prompt if any of the rules are detected to be broken.
 At the root of the repository, run:
 
 ```sh
-curl https://cdn.rawgit.com/tommarshall/git-good-commit/v0.3.0/hook.sh > .git/hooks/commit-msg && chmod +x .git/hooks/commit-msg
+curl https://cdn.rawgit.com/tommarshall/git-good-commit/v0.4.0/hook.sh > .git/hooks/commit-msg && chmod +x .git/hooks/commit-msg
 ```
 
 ### Globally
@@ -37,14 +37,14 @@ To use the hook globally, you can use `git-init`'s template directory:
 ```sh
 mkdir -p ~/.git-template/hooks
 git config --global init.templatedir '~/.git-template'
-curl https://cdn.rawgit.com/tommarshall/git-good-commit/v0.3.0/hook.sh > ~/.git-template/hooks/commit-msg && chmod +x ~/.git-template/hooks/commit-msg
+curl https://cdn.rawgit.com/tommarshall/git-good-commit/v0.4.0/hook.sh > ~/.git-template/hooks/commit-msg && chmod +x ~/.git-template/hooks/commit-msg
 ```
 
 The hook will now be present after any `git init` or `git clone`. You can [safely re-run `git init`](http://stackoverflow.com/a/5149861/885540) on any existing repositories to add the hook there.
 
 ---
 
-_If you're security conscious, you may be reasonably suspicious of [curling executable files](https://www.seancassidy.me/dont-pipe-to-your-shell.html). In this case you're on HTTPS throughout, and not piping directly to execution, so you can check contents and the hash against MD5 `23a607325827a12482bb95a208c4a5ee` for v0.3.0._
+_If you're security conscious, you may be reasonably suspicious of [curling executable files](https://www.seancassidy.me/dont-pipe-to-your-shell.html). In this case you're on HTTPS throughout, and not piping directly to execution, so you can check contents and the hash against MD5 `1bbe22e756fe98dbcc8aae390e20367d` for v0.4.0._
 
 ## Usage
 

hook.sh

@@ -4,7 +4,7 @@
 # git-good-commit(1) - Git hook to help you write good commit messages.
 # Released under the MIT License.
 #
-# Version 0.3.0
+# Version 0.4.0
 #
 # https://github.com/tommarshall/git-good-commit
 #
@@ -110,9 +110,15 @@ validate_commit_message() {
   # reset warnings
   WARNINGS=()
 
+  # capture the subject, and remove the 'squash! ' prefix if present
+  COMMIT_SUBJECT=${COMMIT_MSG_LINES[0]/#squash! /}
+
   # if the commit is empty there's nothing to validate, we can return here
   COMMIT_MSG_STR="${COMMIT_MSG_LINES[*]}"
-  test -n "${COMMIT_MSG_STR[*]// }" || return;
+  test -z "${COMMIT_MSG_STR[*]// }" && return;
+
+  # if the commit subject starts with 'fixup! ' there's nothing to validate, we can return here
+  [[ $COMMIT_SUBJECT == 'fixup! '* ]] && return;
 
   # 1. Separate subject from body with a blank line
   # ------------------------------------------------------------------------------
@@ -123,19 +129,19 @@ validate_commit_message() {
   # 2. Limit the subject line to 50 characters
   # ------------------------------------------------------------------------------
 
-  test "${#COMMIT_MSG_LINES[0]}" -le 50
-  test $? -eq 0 || add_warning 1 "Limit the subject line to 50 characters (${#COMMIT_MSG_LINES[0]} chars)"
+  test "${#COMMIT_SUBJECT}" -le 50
+  test $? -eq 0 || add_warning 1 "Limit the subject line to 50 characters (${#COMMIT_SUBJECT} chars)"
 
   # 3. Capitalize the subject line
   # ------------------------------------------------------------------------------
 
-  [[ ${COMMIT_MSG_LINES[0]} =~ ^[[:blank:]]*([[:upper:]]{1}[[:lower:]]*|[[:digit:]]+)([[:blank:]]|[[:punct:]]|$) ]]
+  [[ ${COMMIT_SUBJECT} =~ ^[[:blank:]]*([[:upper:]]{1}[[:lower:]]*|[[:digit:]]+)([[:blank:]]|[[:punct:]]|$) ]]
   test $? -eq 0 || add_warning 1 "Capitalize the subject line"
 
   # 4. Do not end the subject line with a period
   # ------------------------------------------------------------------------------
 
-  [[ ${COMMIT_MSG_LINES[0]} =~ [^\.]$ ]]
+  [[ ${COMMIT_SUBJECT} =~ [^\.]$ ]]
   test $? -eq 0 || add_warning 1 "Do not end the subject line with a period"
 
   # 5. Use the imperative mood in the subject line
@@ -174,7 +180,7 @@ validate_commit_message() {
   shopt -s nocasematch
 
   for BLACKLISTED_WORD in "${IMPERATIVE_MOOD_BLACKLIST[@]}"; do
-    [[ ${COMMIT_MSG_LINES[0]} =~ $BLACKLISTED_WORD ]]
+    [[ ${COMMIT_SUBJECT} =~ $BLACKLISTED_WORD ]]
     test $? -eq 0 && add_warning 1 "Use the imperative mood in the subject line, e.g 'fix' not 'fixes'" && break
   done
 
@@ -200,14 +206,14 @@ validate_commit_message() {
   # 8. Do no write single worded commits
   # ------------------------------------------------------------------------------
 
-  COMMIT_SUBJECT_WORDS=(${COMMIT_MSG_LINES[0]})
+  COMMIT_SUBJECT_WORDS=(${COMMIT_SUBJECT})
   test "${#COMMIT_SUBJECT_WORDS[@]}" -gt 1
   test $? -eq 0 || add_warning 1 "Do no write single worded commits"
 
   # 9. Do not start the subject line with whitespace
   # ------------------------------------------------------------------------------
 
-  [[ ${COMMIT_MSG_LINES[0]} =~ ^[[:blank:]]+ ]]
+  [[ ${COMMIT_SUBJECT} =~ ^[[:blank:]]+ ]]
   test $? -eq 1 || add_warning 1 "Do not start the subject line with whitespace"
 }
 

test/validation.bats

@@ -24,6 +24,17 @@ EOF
   assert_success
 }
 
+@test "validation: ignores commits with the fixup! autosquash flag" {
+  echo "n" > $FAKE_TTY
+  run git commit -m "$(cat <<EOF
+fixup! Add foo bar string to my_file - As requested by Jon
+Another line in the body that runs to longer than 72 characters in length
+EOF
+)"
+
+  assert_success
+}
+
 # 0. Good commits - control
 # ------------------------------------------------------------------------------
 
@@ -96,6 +107,14 @@ EOF
   assert_line --partial "Limit the subject line to 50 characters (51 chars)"
 }
 
+@test "validation: ignores squash! prefix when checking subject line length" {
+  echo "n" > $FAKE_TTY
+  run git commit -m "squash! Add foo bar string to my_file - As requested by Jo"
+
+  assert_success
+  refute_line --partial "Limit the subject line to 50 characters"
+}
+
 # 3. Capitalize the subject line
 # ------------------------------------------------------------------------------
 
@@ -131,6 +150,14 @@ EOF
   refute_line --partial "Capitalize the subject line"
 }
 
+@test "validation: ignores squash! prefix when checking subject line capitalisation" {
+  echo "n" > $FAKE_TTY
+  run git commit -m "squash! Add foo bar string to my_file"
+
+  assert_success
+  refute_line --partial "Capitalize the subject line"
+}
+
 # 4. Do not end the subject line with a period
 # ------------------------------------------------------------------------------