From a61eba03d78411b0e711873530f4d03793e788e8 Mon Sep 17 00:00:00 2001 From: Muhammad Dadu Date: Thu, 12 Jan 2017 21:00:57 +0000 Subject: [PATCH] moved CHANGELOG and added docgen --- docs/CHANGELOG.md => CHANGELOG.md | 0 Gruntfile.js | 17 +++++++++++++++-- package.json | 6 +++++- 3 files changed, 20 insertions(+), 3 deletions(-) rename docs/CHANGELOG.md => CHANGELOG.md (100%) diff --git a/docs/CHANGELOG.md b/CHANGELOG.md similarity index 100% rename from docs/CHANGELOG.md rename to CHANGELOG.md diff --git a/Gruntfile.js b/Gruntfile.js index bab9191..a43bb03 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -8,11 +8,24 @@ module.exports = function(grunt) { grunt.initConfig({ mochaTest: { test: { - src: ['test/**/*_test.js'] + src: ['test/*_test.js'] } - } + }, + jsdoc : { + dist : { + src: ['bin/**/*.js', 'hooks/**/*.js', 'lib/**/*.js', 'test/**/*.js', 'index.js'], + options: { + destination: 'docs' + } + } + } }); grunt.loadNpmTasks('grunt-mocha-test'); + grunt.loadNpmTasks('grunt-jsdoc'); + grunt.registerTask('test', 'mochaTest'); + grunt.registerTask('jsdoc', ['mochaTest', 'jsdoc']); + + grunt.registerTask('defualt', ['mochaTest', 'jsdoc']); }; diff --git a/package.json b/package.json index 2712acd..df0bcc1 100644 --- a/package.json +++ b/package.json @@ -5,6 +5,7 @@ "main": "index.js", "scripts": { "start": "node .", + "grunt": "grunt", "test": "grunt test" }, "keywords": [ @@ -38,8 +39,11 @@ }, "devDependencies": { "grunt": "^1.0.1", + "grunt-jsdoc": "^2.1.0", "grunt-mocha-test": "^0.12.7", + "jsdoc": "^3.4.3", "mocha": "^2.4.5", - "should": "^8.3.1" + "should": "^8.3.1", + "sinon": "^1.17.7" } }