https://github.com/mdasberg/grunt-code-quality-report
https://github.com/mdasberg/grunt-code-quality-report
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/mdasberg/grunt-code-quality-report
- Owner: mdasberg
- License: mit
- Created: 2013-10-08T19:48:15.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-02-21T19:00:50.000Z (over 9 years ago)
- Last Synced: 2025-04-25T18:57:55.982Z (about 1 month ago)
- Language: JavaScript
- Size: 348 KB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG
- License: LICENSE-MIT
Awesome Lists containing this project
README
# grunt-code-quality-report
> Grunt plugin that reports on [Karma](https://github.com/karma-runner/karma) junit and coverage and [Jshint](http://www.jshint.com/) results as a code quality reporter.
## Getting Started
This plugin requires Grunt `~0.4.1`
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
```shell
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:
```js
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()`.
```js
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.
```js
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.
```js
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](http://gruntjs.com/).
## Release History
See the [CHANGELOG](CHANGELOG).