test: Add tests

Author: tmcw

Gruntfile.js

@@ -0,0 +1,37 @@
+'use strict';
+
+module.exports = function(grunt) {
+  grunt.initConfig({
+    documentation: {
+      default: {
+        files: [
+          {
+            expand: true,
+            cwd: 'tasks',
+            src: ['**/*.js']
+          }
+        ],
+        options: {
+          destination: 'test/tmp'
+        }
+      }
+    },
+    nodeunit: {
+      tasks: ['test/test.js']
+    },
+    clean: {
+      test: ['test/tmp/**']
+    }
+  });
+
+  grunt.loadTasks('tasks');
+  grunt.loadNpmTasks('grunt-contrib-clean');
+  grunt.loadNpmTasks('grunt-contrib-nodeunit');
+
+  grunt.registerTask('default', [
+    'clean',
+    'documentation',
+    'nodeunit',
+    'clean'
+  ]);
+};

package.json

@@ -26,6 +26,8 @@
   "devDependencies": {
     "cz-conventional-changelog": "^2.0.0",
     "grunt": "latest",
+    "grunt-contrib-clean": "^1.1.0",
+    "grunt-contrib-nodeunit": "^1.0.0",
     "husky": "^0.13.3",
     "lint-staged": "^3.4.0",
     "prettier": "^1.2.2",

tasks/documentation.js

@@ -11,6 +11,39 @@ var path = require('path'),
   documentation = require('documentation'),
   formats = require('documentation').formats;
 
+/**
+ * Grunt Documentation
+ *
+ * In your project's Gruntfile, add a section named `documentation` to the
+ * data object passed into `grunt.initConfig()`.
+ *
+ * @param {Object} options
+ * @param {string} options.destination
+ * @param {string} [options.format=html] one of `'html'`, `'md'`, `'json'`
+ * @param {string} options.filename custom filename for md or json
+ * @param {Array<string>} [options.access=[protected,public,undefined]  Include only
+ * comments with a given access level, out of `private`, `protected`, `public`
+ * and `undefined`. By default, `public`, `protected` and `undefined` access levels are included.
+ * @param {Array<string>} [options.order=[]] Explicit sort order
+ * @param {string} [options.theme=''] Custom theme
+ * @param {string} [options.name=''] project name
+ * @param {string} [options.version=''] project version
+ * @example
+ * grunt.initConfig({
+ *   documentation: {
+ *       default: {
+ *           files: [{
+ *               "expand": true,
+ *               "cwd": "src",
+ *               "src": ["**\/*.js"]
+ *           }],
+ *           options: {
+ *               destination: "docs"
+ *           }
+ *       },
+ *   }
+ * });
+ */
 function gruntDocumentation(grunt) {
   grunt.registerMultiTask(
     'documentation',

test/test.js

@@ -0,0 +1,10 @@
+'use strict';
+var fs = require('fs');
+
+exports.documentationjs = {
+  run: function(test) {
+    var code = fs.readFileSync('test/tmp/index.html', 'utf8');
+    test.ok(/gruntDocumentation/.test(code));
+    test.done();
+  }
+};