Skip to content

Diff Quality

Jump to bottom Edit New page
Sarina Canelake edited this page Jul 10, 2013 · 5 revisions

@sarina and @peter-fogg added support for code quality checking in diff-cover.

The branch: https://github.com/edx/diff-cover/tree/quality-violations

The Pull Request https://github.com/edx/diff-cover/pull/22

Usage of diff-quality is similar to that of diff-cover (see the README for more details). The report format is modified to include line numbers and error messages from the checker. Currently only pylint and pep8 are supported; however, it should be quite easy to add support for additional style checkers (jslint? coffeelint?).

Here is how you use the pep8 and pylint quality violations reporters for a console output:

pep8 quality violations in console

pylint quality violations in console

Adding --html-report=path/to/report.html to the end of the command will generate an HTML report at the specified location. The html reports look something like this:

pep8 html report

pylint html report

Add a custom footer
Add a custom sidebar
Clone this wiki locally