Merge pull request #3 from GrayedFox/20170717

release-20170717

Author: GrayedFox

README.md

@@ -1,18 +1,15 @@
-This handy little module checks if the currently checked our branch
-has been squashed or not (based on the number of commits the branch has).
+This handy little module checks if the currently checked out branch
+needs squashing. It uses a native git command to count the number of
+unique commits the branch has (read: commits not present on develop).
 
-Now if you're following the GitFlow branching model you can add a check
-to your desired CI pipeline to ensure developers don't merge feature
-branches without rebasing/squashing them first!
-
-Install using npm
+Install using npm:
 
 `npm install squashed --save-dev`
 
-Then from inside the squashed npm package folder, do
+Then from inside the squashed npm package folder
+(`node_modules/squashed/`), do:
 
 `npm link`
 
-Now simply navigate to the root folder of the git project and type
-`squashed` into your command line. Will output a message and also return
- true or false so that it can be easily integrated into a CI task runner.
+Now simply type "squashed" into the terminal from any Git folder to see
+if you need to squash those commits or not!

app.js

@@ -1,15 +1,64 @@
+const fs = require('fs')
 const execProcess = require('./execProcess.js')
 
-execProcess.result('sh node_modules/squashed/countBranchCommits.sh', function(err, response) {
-  if (err) {
-    console.log(err)
-  } else {
-    if (response > 1) {
-      console.log('You need to squash your commits! Do a rebase!')
+let path = './node_modules/squashed/commands/'
+let commitRef = 'HEAD'
+
+// Function which returns a promise so we can chain command execution
+const commandHandler = (command) => {
+  return new Promise((resolve, reject) => {
+    execProcess.result(`sh ${path}${command}`, (err, response) => {
+      if (err) {
+        reject(err)
+      } else {
+        resolve(response)
+      }
+    })
+  })
+}
+
+// Updates the exitCode and logs errors form command promise rejections
+const errorHandler = (error) => {
+  console.error(error)
+  process.exit(1)
+}
+
+// Log squashed messages in blue so they stand out
+const prettyLog = (message) => {
+  console.log(`\x1b[34m${message}\x1b[0m`)
+}
+
+// Initialisation and env setup
+const init = () => {
+  // if not installed via Node Package Manager adjust path to root (for debugging local builds)
+  try {
+    (!fs.lstatSync(path).isDirectory())
+  } catch(err) {
+    if (err.code === 'ENOENT') {
+      path = './commands/'
+    }
+  }
+
+  // if run inside Travis CI we need to ensure we update the commitRef since we are working in a detached head state
+  if (process.env.TRAVIS_PULL_REQUEST_BRANCH) {
+    commitRef = process.env.TRAVIS_PULL_REQUEST_SHA
+  }
+  console.log(`Commit reference: ${commitRef}`)
+}
+
+init()
+
+Promise.all([commandHandler(`getBranchCommitCount.sh ${commitRef}`), commandHandler('getFormattedBranchCommits.sh')]).then(
+  ([commitCount, formattedBranchCommits]) => {
+    if (commitCount > 1) {
+      console.log(`
+${formattedBranchCommits}`)
+      prettyLog(`
+      You need to squash those ${+commitCount} commits!
+      `)
       process.exit(1)
     } else {
-      console.log('Merge away McLoven')
+      prettyLog('Merge away McLoven :)')
       process.exit(0)
     }
-  }
-})
+  }, errorHandler)

bin/squashed

@@ -1,4 +1,5 @@
 #! /usr/bin/env node
 
 squashedResult = require('../app.js')
+
 squashedResult

commands/getBranchCommitCount.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+git rev-list $1 --not origin/develop --count

commands/getForammtedBranchCommits.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+git log --first-parent origin/develop --graph --abbrev-commit --decorate --format=format:'%C(bold blue)%h%C(reset) - %C(bold cyan)%aD%C(reset) %C(bold green)(%ar)%C(reset)%C(bold yellow)%d%C(reset)%n''          %C(white)%s%C(reset) %C(dim white)- %an%C(reset)'

commands/getStatus.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+git status

countBranchCommits.sh

@@ -1,6 +1,6 @@
 {
   "name": "squashed",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "A nifty tool to check if your branch needs to be rebased/squashed",
   "main": "app.js",
   "bin": {