grunt-code-quality-report

grunt-code-quality-report

Grunt plugin that reports on Karma junit and coverage and Jshint results as a code quality reporter.

Getting Started

This plugin requires Grunt ~0.4.1

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-code-quality-report --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-code-quality-report');

The "code_quality_report" task

Overview

In your project's Gruntfile, add a section named code_quality_report to the data object passed into grunt.initConfig().

grunt.initConfig({
  code_quality_report: {
     options: {
        dir: 'test/results',
        file: 'result.json'
     },
     your_target: {
        junit: {
           results: {
              file: 'test/test-results.xml',
              details: false/true
           },
           coverage: {
              file: 'test/coverage.json'
           }
        },
        e2e: {
           results: {
              file: 'test/e2e.xml',
              details: false/true
           },
           coverage: {
              file: 'test/coverage.json'
           }
        },
        jshint: {
           file:'path/to/jshint/div/result-file.xml',
           details: false/true
        }
     }
  }
})

Options

options.dir

Type: String Default value: '.'

The directory location where the result is stored.

options.file

Type: String Default value: 'result.json'

The name of the file in which the result is stored.

Usage Examples

Default Options

In this example, the default options are used for writing the result.

grunt.initConfig({
  code_quality_report: {
     options: {},
     your_target: {
        junit: {
           results: {
              file: 'test/test-results.xml'
           },
           coverage: {
              file: 'test/coverage.json'
           }
        },
        e2e: {
           results: {
              file: 'test/e2e.xml'
           },
           coverage: {
              file: 'test/coverage.json'
           }
        },
        jshint: {
           file:'path/to/jshint/div/result-file.xml'
        }
     }
  }
})

Custom Options

In this example, custom options are used to for writing the result.

grunt.initConfig({
  code_quality_report: {
     options: {
        dir: 'test/results',
        file: 'result.json'
     },
     your_target: {
        junit: {
           results: {
              file: 'test/test-results.xml',
              details: false/true
           },
           coverage: {
              dir: 'test/coverage*.json',
           }
        },
        e2e: {
           results: {
              file: 'test/e2e.xml',
              details: false/true
           },
           coverage: {
              dir: 'test/coverage*.json'
           }
        },
        jshint: {
           file:'path/to/jshint/div/result-file.xml',
           details: false/true
        }
     }
  }
})

Contributing

In line 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.

Release History

See the CHANGELOG.