grunt-complexity-updater

Reads "maintainability" threshold from .complexityrc, runs grunt-complexity and auto-updates it when "increased maintainability" was detected.

Note: It's assumed that you're already using the grunt-complexity module so it's not included as dependency.

Usage

$ npm install grunt-complexity-updater

// in your Gruntfile.js
grunt.initConfig({
  complexity: {
    generic: {
      src: ['lib/*.js'],
      options: grunt.file.readJSON('.complexityrc')
    }
  }
});
 
grunt.loadNpmTasks('grunt-complexity-updater');
 
// a little shortcut
grunt.registerTask('test', ['update-grunt-complexity-values'])

Create a .complexityrc file and make it look like:

{
  "maintainability":      1,      // initial value, will be updated on next run
  "broadcast":            true,   // make grunt-complexity broadcasting data
 
  // following settings are up to you
  //
  "breakOnErrors":        true|false,
  "errorsOnly":           true|false,
  "cyclomatic":           0,
  "halstead":             0,
  "hideComplexFunctions": false,
}

You're done. Now run $ grunt update-grunt-complexity-values.

Licence

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THEWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

grunt-complexity-updater