Merge pull request #10 from iilei/add_github_option

Add option - boolean: infer github links

Author: tmcw

index.js

@@ -42,6 +42,9 @@ var through2 = require('through2'),
  */
 module.exports = function (options) {
   options = options || {};
+  var docOptions = {
+    github : !!(options.github || options.g)
+  };
   var files = [];
   options.format = options.format || 'html';
   var formatter = documentation.formats[options.format];
@@ -54,7 +57,7 @@ module.exports = function (options) {
   }, function (cb) {
     documentation(files.map(function(file) {
       return file.path;
-    }), {}, function(err, comments) {
+    }), docOptions, function(err, comments) {
       formatter(comments, {}, function (err, output) {
         if (options.format === 'json' || options.format === 'md') {
           this.push(new File({

package.json

@@ -13,6 +13,7 @@
     "gulp": "^3.8.11",
     "concat-stream": "^1.4.8",
     "prova": "^2.1.1",
+    "proxyquire": "^1.7.3",
     "tape": "^3.5.0"
   },
   "keywords": [

test/test.js

@@ -2,6 +2,7 @@ var test = require('prova'),
   path = require('path'),
   concat = require('concat-stream'),
   gulp = require('gulp'),
+  proxyquire = require('proxyquire'),
   documentation = require('../');
 
 test('gulp-documentation', function(t) {
@@ -45,6 +46,24 @@ test('gulp-documentation html', function(t) {
     }));
 });
 
+test('gulp-documentation github links', function(t) {
+  var through2Stub = {
+      obj : function (indexes, callback) {
+        callback.call();
+      }
+    },
+    documentationStub = function(indexes, options) {
+      t.equal(options.github, true);
+      t.end();
+    },
+    documentationjs = proxyquire('../', {
+      'through2': through2Stub,
+      'documentation': documentationStub
+    });
+
+  documentationjs({ format: 'html', github: true });
+});
+
 test('gulp-documentation exit callback', function(t) {
   t.plan(1);
   gulp.src(path.join(__dirname, '/fixture.js'))