renamed the project from ghelp to make-help

.travis.yml

@@ -5,4 +5,4 @@ notifications:
   email:
     on_failure: always
     on_success: never
-script: bats/bin/bats --tap test/ghelp
+script: bats/bin/bats --tap test/make-help

Makefile

@@ -12,7 +12,7 @@ help:
 	echo '    make <target>'
 	echo ''
 	echo '  Targets:'
-	bin/ghelp -p 4 $(lastword $(MAKEFILE_LIST))
+	bin/make-help -p 4 $(lastword $(MAKEFILE_LIST))
 	echo ''
 
 # grab dependencies
@@ -21,4 +21,4 @@ install:
 
 # run the program's tests
 test:
-	test/ghelp
+	test/make-help

README.md

@@ -1,4 +1,4 @@
-# ghelp [![Build Status](https://travis-ci.org/gibatronic/ghelp.svg?branch=master)](https://travis-ci.org/gibatronic/ghelp)
+# make-help [![Build Status](https://travis-ci.org/gibatronic/make-help.svg?branch=master)](https://travis-ci.org/gibatronic/make-help)
 
 This is a [basher](https://github.com/basherpm/basher) and [npm](https://www.npmjs.com/) package to help you document your make tasks.
 
@@ -8,10 +8,10 @@ Install this package with one of the following commands:
 
 ```shell
 # through basher
-basher install gibatronic/ghelp
+basher install gibatronic/make-help
 
 # or through npm
-npm install ghelp --global
+npm install make-help --global
 ```
 
 Then comment the targets you wish to document in your `makefile`, for example:
@@ -39,7 +39,7 @@ help:
 	echo '    make <target>'
 	echo ''
 	echo '  Targets:'
-	ghelp -p 4 "$(lastword $(MAKEFILE_LIST))"
+	make-help -p 4 "$(lastword $(MAKEFILE_LIST))"
 	echo ''
 ```
 

bin/ghelp → bin/make-help

@@ -48,7 +48,7 @@ resolve_path() {
 usage() {
   echo ''
   echo '  Usage:'
-  echo '    ghelp [options] <makefile>'
+  echo '    make-help [options] <makefile>'
   echo ''
   echo '  Options:'
   echo '    -p --pad  the number of spaces to prefix each line'

package.json

@@ -4,13 +4,13 @@
     "name": "Gibran Malheiros",
     "url": "http://gibatronic.github.io/"
   },
-  "bin": "bin/ghelp",
+  "bin": "bin/make-help",
   "bugs": {
     "email": "[email protected]",
-    "url": "https://github.com/gibatronic/ghelp/issues"
+    "url": "https://github.com/gibatronic/make-help/issues"
   },
-  "description": "Using make as a task runner? Then document your tasks with ghelp!",
-  "homepage": "https://github.com/gibatronic/ghelp",
+  "description": "Using make as a task runner? Then document your tasks running make help!",
+  "homepage": "https://github.com/gibatronic/make-help",
   "keywords": [
     "help",
     "make",
@@ -20,10 +20,10 @@
     "usage"
   ],
   "license": "MIT",
-  "name": "ghelp",
+  "name": "make-help",
   "repository": {
     "type": "git",
-    "url": "https://github.com/gibatronic/ghelp.git"
+    "url": "https://github.com/gibatronic/make-help.git"
   },
   "version": "0.0.2"
 }

test/make-help

@@ -0,0 +1,31 @@
+#!/usr/bin/env bats
+
+@test 'should parse the simple fixture' {
+  local MAKE_HELP_OUTPUT=$(bin/make-help test/fixtures/simple.in)
+  echo "${MAKE_HELP_OUTPUT}" | diff - test/fixtures/simple.out
+}
+
+@test 'should sort the tasks in the unsorted fixture' {
+  local MAKE_HELP_OUTPUT=$(bin/make-help test/fixtures/unsorted.in)
+  echo "${MAKE_HELP_OUTPUT}" | diff - test/fixtures/unsorted.out
+}
+
+@test 'should pad the output with -p 2' {
+  local MAKE_HELP_OUTPUT=$(bin/make-help -p 2 test/fixtures/pad.in)
+  echo "${MAKE_HELP_OUTPUT}" | diff - test/fixtures/pad.out
+}
+
+@test 'should pad the output with --pad 2' {
+  local MAKE_HELP_OUTPUT=$(bin/make-help --pad 2 test/fixtures/pad.in)
+  echo "${MAKE_HELP_OUTPUT}" | diff - test/fixtures/pad.out
+}
+
+@test 'should pad the output with --pad=2' {
+  local MAKE_HELP_OUTPUT=$(bin/make-help --pad=2 test/fixtures/pad.in)
+  echo "${MAKE_HELP_OUTPUT}" | diff - test/fixtures/pad.out
+}
+
+@test 'should ignore loose comments and targets' {
+  local MAKE_HELP_OUTPUT=$(bin/make-help test/fixtures/loose.in)
+  echo "${MAKE_HELP_OUTPUT}" | diff - test/fixtures/loose.out
+}