style(prettier): Use prettier for code formatting

Also fixes the position of the GreenKeeper badge in the README

Refs documentationjs/documentation#709 the main issue for documentation

Author: tmcw

README.md

@@ -1,9 +1,8 @@
 # gulp-documentation
 
+[![Circle CI](https://circleci.com/gh/documentationjs/gulp-documentation.svg?style=shield)](https://circleci.com/gh/documentationjs/gulp-documentation)
 [![Greenkeeper badge](https://badges.greenkeeper.io/documentationjs/gulp-documentation.svg)](https://greenkeeper.io/)
 
-[![Circle CI](https://circleci.com/gh/documentationjs/gulp-documentation.svg?style=svg)](https://circleci.com/gh/documentationjs/gulp-documentation)
-
 Use [gulp](http://gulpjs.com/) with
 [documentation](https://github.com/documentationjs/documentation)
 to generate great documentation for your JavaScript projects.

index.js renamed to lib/index.js

@@ -68,35 +68,53 @@ var File = require('vinyl');
  *     .pipe(gulp.dest('html-documentation'));
  * });
  */
-module.exports = function (format, options, formatterOptions) {
+module.exports = function(format, options, formatterOptions) {
   options = options || {};
   formatterOptions = formatterOptions || {};
   var files = [];
   format = format || 'md';
   var formatter = documentation.formats[format];
   if (!formatter) {
-    throw new Error('invalid format given: valid options are ' + Object.keys(documentation.formats).join(', '));
+    throw new Error(
+      'invalid format given: valid options are ' +
+        Object.keys(documentation.formats).join(', ')
+    );
   }
-  return through2.obj(function document(file, enc, cb) {
-    files.push(file);
-    cb();
-  }, function (cb) {
-    documentation.build(files.map(function(file) {
-      return file.path;
-    }), options, function(err, comments) {
-      formatter(comments, formatterOptions, function (err, output) {
-        if (format === 'json' || format === 'md') {
-          this.push(new File({
-            path: options.filename || 'API.' + format,
-            contents: new Buffer(output)
-          }));
-        } else if (format === 'html') {
-          output.forEach(function(file) {
-            this.push(file);
-          }.bind(this));
-        }
-        cb();
-      }.bind(this));
-    }.bind(this));
-  });
+  return through2.obj(
+    function document(file, enc, cb) {
+      files.push(file);
+      cb();
+    },
+    function(cb) {
+      documentation.build(
+        files.map(function(file) {
+          return file.path;
+        }),
+        options,
+        function(err, comments) {
+          formatter(
+            comments,
+            formatterOptions,
+            function(err, output) {
+              if (format === 'json' || format === 'md') {
+                this.push(
+                  new File({
+                    path: options.filename || 'API.' + format,
+                    contents: new Buffer(output)
+                  })
+                );
+              } else if (format === 'html') {
+                output.forEach(
+                  function(file) {
+                    this.push(file);
+                  }.bind(this)
+                );
+              }
+              cb();
+            }.bind(this)
+          );
+        }.bind(this)
+      );
+    }
+  );
 };

package.json

@@ -4,15 +4,17 @@
   "version": "3.1.0",
   "author": "Tom MacWright",
   "dependencies": {
-    "documentation": "4.0.0-beta16",
+    "documentation": "4.0.0-beta.18",
     "through2": "^2.0.1",
     "vinyl": "^2.0.0"
   },
   "devDependencies": {
     "concat-stream": "^1.4.8",
     "cz-conventional-changelog": "^2.0.0",
-    "eslint": "^3.9.1",
     "gulp": "^3.8.11",
+    "husky": "^0.13.3",
+    "lint-staged": "^3.4.0",
+    "prettier": "^0.22.0",
     "tap": "10.3.2"
   },
   "keywords": [
@@ -22,18 +24,24 @@
     "jsdoc"
   ],
   "license": "BSD-2-Clause",
-  "main": "index.js",
+  "main": "lib/index.js",
   "repository": {
     "type": "git",
     "url": "[email protected]:documentationjs/gulp-documentation.git"
   },
   "scripts": {
-    "test": "eslint . && tap test/test.js",
+    "precommit": "lint-staged --verbose",
+    "format": "prettier --write '{lib,test}/**/*.js' --single-quote",
     "docs": "documentation readme index.js --section=API"
   },
   "config": {
     "commitizen": {
       "path": "./node_modules/cz-conventional-changelog"
     }
+  },
+  "lint-staged": {
+    "*.js": [
+      "prettier --write --single-quote"
+    ]
   }
 }

test/test.js

@@ -10,7 +10,8 @@ test('gulp-documentation', function(t) {
 });
 
 test('gulp-documentation md', function(t) {
-  gulp.src(path.join(__dirname, '/fixture.js'))
+  gulp
+    .src(path.join(__dirname, '/fixture.js'))
     .pipe(documentation('md', {}, {}))
     .on('data', function(d) {
       t.equal(d.path, 'API.md');
@@ -19,7 +20,8 @@ test('gulp-documentation md', function(t) {
 });
 
 test('gulp-documentation md custom name', function(t) {
-  gulp.src(path.join(__dirname, '/fixture.js'))
+  gulp
+    .src(path.join(__dirname, '/fixture.js'))
     .pipe(documentation('md', { filename: 'foo.md' }))
     .on('data', function(d) {
       t.equal(d.path, 'foo.md');
@@ -28,7 +30,8 @@ test('gulp-documentation md custom name', function(t) {
 });
 
 test('gulp-documentation json', function(t) {
-  gulp.src(path.join(__dirname, '/fixture.js'))
+  gulp
+    .src(path.join(__dirname, '/fixture.js'))
     .pipe(documentation('json'))
     .on('data', function(d) {
       t.ok(JSON.parse(d.contents), 'is json');
@@ -37,18 +40,24 @@ test('gulp-documentation json', function(t) {
 });
 
 test('gulp-documentation html', function(t) {
-  gulp.src(path.join(__dirname, '/fixture.js'))
+  gulp
+    .src(path.join(__dirname, '/fixture.js'))
     .pipe(documentation('html'))
-    .pipe(concat(function(d) {
-      t.equal(d.length, 34);
-      t.end();
-    }));
+    .pipe(
+      concat(function(d) {
+        t.equal(d.length, 34);
+        t.end();
+      })
+    );
 });
 
 test('gulp-documentation exit callback', function(t) {
   t.plan(1);
-  gulp.src(path.join(__dirname, '/fixture.js'))
+  gulp
+    .src(path.join(__dirname, '/fixture.js'))
     .pipe(documentation('md'))
-    .on('end', function() { t.pass(); })
+    .on('end', function() {
+      t.pass();
+    })
     .resume();
 });