Software complexity analysis for JavaScript projects.
You need node >= 4, npm and grunt >= 0.4.5 installed and your project build managed by a Gruntfile with the necessary modules listed in package.json. If you haven't used Grunt before, be sure to check out the [Getting Started] guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
$ npm install grunt-escomplex-report --save-devAdd the escomplex-report entry with the task configuration to the options of the grunt.initConfig method:
grunt.initConfig({
'escomplex-report': {
all: {
src: ['../../src/**/!(*.spec)+(.js)'],
options: {
output: 'complexity.txt'
}
}
}
});Default options support the most usual usage scenario:
'escomplex-report': {
options: {
format: 'plain',
output: null,
onlyfailures: true,
silent: false,
newmi: true,
force: false
},
...
}Type: Boolean
Default value: false
If set to true, it suppresses complexity failures. Instead of making the Grunt fail, the errors will be written only to the console.
Type: String
Default value: null
Specify the output format of the report.
Type: String
Default value: null
Specify an output file for the report.
Type: Boolean
Default value: false
Ignore parser errors.
Type: Number
Default value: 1024
Specify the maximum number of files to have open at any point.
Type: Number
Default value: null
Specify the per-project first-order density threshold.
Type: Number
Default value: null
Specify the per-project change cost threshold.
Type: Number
Default value: null
Specify the per-project core size threshold.
Type: Number
Default value: null
Specify the per-module maintainability index threshold.
Type: Number
Default value: null
Specify the per-function cyclomatic complexity threshold.
Type: Number
Default value: null
Specify the per-function cyclomatic complexity density threshold.
Type: Number
Default value: null
Specify the per-function Halstead difficulty threshold.
Type: Number
Default value: null
Specify the per-function Halstead volume threshold.
Type: Number
Default value: null
Specify the per-function Halstead effort threshold.
Type: Boolean
Default value: true
Report only modules and functions, which failed the complexity checks.
Type: Boolean
Default value: false
Do not write any output to the console.
Type: Boolean
Default value: false
Cisregard operator || as source of cyclomatic complexity.
Type: Boolean
Default value: false
Disregard switch statements as source of cyclomatic complexity.
Type: Boolean
Default value: false
Treat for...in statements as source of cyclomatic complexity.
Type: Boolean
Default value: false
Treat catch clauses as source of cyclomatic complexity.
Type: Boolean
Default value: true
Use the Microsoft-variant maintainability index (scale of 0 to 100).
Type: Boolean
Default value: false
Do not calculate core size or visibility matrix.
Type: String|Array|Object
Default value: []
Source files to have their complexity checked. Grunt file list specification.
Load the plugin in Gruntfile.js:
grunt.loadNpmTasks('grunt-escomplex-report');Call the escomplex-report task:
$ grunt escomplex-reportor integrate it to your build sequence in Gruntfile.js:
grunt.registerTask('default', ['escomplex-report', ...]);In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
- 2018-05-03 v1.0.1 Supported installation if NPM proxy cache is used
- 2018-04-27 v1.0.0 Dropped support of Node.js 4
- 2018-01-29 v0.0.1 Initial release
Copyright (c) 2018-2019 Ferdinand Prantl
Licensed under the MIT license.
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent