mpulse-query/Gruntfile.js

SOASTA mPulse Query REST API interface for Javascript

/* eslint-env node */

/**
 * @namespace BuildConfiguration
 * @desc
 * Documents the constants used during build and compilation as builtin
 * compilation and build configuration documentation
 *
 * The build is executed through Grunt the generic taskrunner.
 */

/**
 * @constant mochaTestFiles
 * @memberof BuildConfiguration
 * @type {String[]}
 * @desc
 * Array of files to use to run the Unittests on the code base
 */
var mochaTestFiles = [
	"tests/blanket.js",
	"tests/index.js",
	"tests/base/*.js",
	"tests/logging/*.js"
];

/**
 * @constant coverageHtml
 * @memberof BuildConfiguration
 * @type {string}
 * @desc
 * Destination path to the unittest coverage report
 */
var coverageHtml = "tests/results/coverage.html";

/**
 * @constant junitReportFile
 * @memberof BuildConfiguration
 * @type {string}
 * @desc
 * Destination path for the JUnit XML format report of the UnitTest run
 */
var junitReportFile = "tests/results/junit.xml";

/**
 * @constant jsdocSourceFiles
 * @memberof BuildConfiguration
 * @type {String[]}
 * @desc
 * Array of file sources to generate the documentation from
 */
var jsdocSourceFiles = [
	"lib/**/*.js",
	"./*.js",
	"node_modules/soasta-repository/lib/**/*.js"
];

/**
 * @constant jsdocTutorialPath
 * @memberof BuildConfiguration
 * @type {string}
 * @desc
 * Directory containing tutorials and other documentation not to be distributed as source code files
 */
var jsdocTutorialPath = "doc/tutorials";

/**
 * @constant sourcePaths
 * @memberof BuildConfiguration
 * @type {string[]}
 * @desc
 * A list of all paths to javascript files
 */
var sourcePaths = [
	"./lib/**/*.js",
	"./Gruntfile.js",
	"./index.js",
	"./tests/**/*.js"
];


module.exports = function(grunt) {
	"use strict";

	var lintFiles = [
		"*.js",
		"cli/*.js",
		"lib/**/*.js",
		"test/*.js"
	];

	// Project configuration.
	grunt.initConfig({
		pkg: grunt.file.readJSON("package.json"),
		eslint: {
			console: {
				options:{
					"format": "compact"
				},
				src: lintFiles
			},
			build: {
				options: {
					"output-file": "eslint.xml",
					"format": "jslint-xml",
					"silent": true
				},
				src: lintFiles
			}
		},
		mochaTest: {
			test: {
				options: {
					reporter: "tap",
					captureFile: "test/mocha.tap"
				},
				src: [
					"test/*.js"
				]
			}
		},
		karma: {
			options: {
				singleRun: true,
				colors: true,
				configFile: "./karma.config.js",
				preprocessors: {
					"./src/*.js": ["coverage"]
				},
				basePath: "./",
				files: [
					"lib/mocha/mocha.css",
					"lib/mocha/mocha.js",
					"lib/node-assert/assert.js",
					"lib/assertive-chai/dist/assertive-chai.js",
					"src/mpulse.js",
					"test/*.js"
				]
			},
			console: {
				browsers: ["PhantomJS"],
				frameworks: ["mocha"]
			}
		},
		jsdoc: {
			dist: {
				options: {
					destination: "doc",
					readme: "README.md",
					package: "package.json",
					template : "node_modules/grunt-jsdoc/node_modules/ink-docstrap/template",
					configure : "node_modules/grunt-jsdoc/node_modules/ink-docstrap/template/jsdoc.conf.json",
					tutorials: "./doc/tutorials",
					verbose: true,
					plugins: [
						"node_modules/grunt-jsdoc/node_modules/jsdoc/plugins/markdown"
					]
				},
				src: jsdocSourceFiles
			}
		},
		bower: {
			install: {
				options: {
					targetDir: "lib"
				}
			}
		}
	});

	//
	// Plugins
	//
	grunt.loadNpmTasks("grunt-bower-task");
	grunt.loadNpmTasks("grunt-karma");
	grunt.loadNpmTasks("grunt-mocha-test");
	grunt.loadNpmTasks("gruntify-eslint");
	grunt.loadNpmTasks("grunt-jsdoc");

	//
	// Tasks
	//
	grunt.registerTask("test", ["bower:install", "mochaTest", "karma:console"]);

	grunt.registerTask("lint", ["eslint:console"]);
	grunt.registerTask("lint:build", ["eslint:build"]);

	//
	// Task Groups
	//
	grunt.registerTask("default", ["lint"]);
	grunt.registerTask("all", ["lint:build", "test"]);
};