grunt-complexity

Grunt-Complexity

A grunt task that utilizes complexity-report to evaluate the complexity and maintainability of code.

Versions

• Use version 0.0.7 for Grunt 0.3.x
• Use versions 0.1.x for Grunt 0.4.x

Usage

npm install grunt-complexity --save

Within your grunt file:

    // Project configuration.
	grunt.initConfig({

		complexity: {
			generic: {
				src: ['grunt.js', 'tasks/grunt-complexity.js'],
				options: {
					breakOnErrors: true,
					jsLintXML: 'report.xml',         // create XML JSLint-like report
					checkstyleXML: 'checkstyle.xml', // create checkstyle report
					errorsOnly: false,               // show only maintainability errors
					cyclomatic: [3, 7, 12],          // or optionally a single value, like 3
					halstead: [8, 13, 20],           // or optionally a single value, like 8
					maintainability: 100
				}
			}
		}


	});

	grunt.loadNpmTasks('grunt-complexity');
	grunt.registerTask('default', 'complexity');

What is Cyclomatic and Halstead?

Documentation on this to come. For now, see jscomplexity.org

Contributing

This repo has a submodule, so after you npm install, you'll want to git submodule init and git submodule update.

Then, you should cd test/grunt.0.4 and npm install.

Tests can be run with mocha.

Contributors

• Nate Hunzaker(nhunzaker)
• Golo Roden (goloroden)
• Tomasz Drwięga (tomusdrw)
• Doug Avery (averyvery)
• Jozsef Kozma (jzsfkzm)
• Patrick Williams (pwmckenna)
• Luís Couto (Couto)