Android Check 2
Static code analysis plugin for Android projects. This is a fork of the original android-check plugin, which implements a really useful concept, but unfortunately seems abandoned.
Who uses this?
Build status
master
dev
Usage
This plugin is available in the Gradle Plugin Portal and jCenter. It attaches itself to the check
task if it finds it (that is, you don't use the plugins
block and you apply either the application or library Android plugins first) - otherwise you'll need to execute the corresponding tasks manually when desired: androidCheckstyle
for CheckStyle, and androidPmd
for PMD.
Configuration
Recommended
The default one.
Customized
// Configuration is completely optional, defaults will be used if not present check {
// Do absolutely nothing, default: false
skip true/false
// Fails build if a violation is found, default: true
abortOnError true/false. Ignored if all per-tool confs are set to abortOnError false (see below)
// Checkstyle configuration
checkstyle {
// Completely skip CheckStyle, default: false
skip true/false
// Fails build if CheckStyle rule violation is found, default: false
abortOnError true/false
// Configuration file for CheckStyle, default: <project_path>/config/checkstyle.xml, if non-existent then <project_path>/<module_path>/config/checkstyle.xml, if non-existent then plugin/src/main/resources/checkstyle/conf-default.xml
config 'path/to/checkstyle.xml'
// Output file for XML reports, default: new File(project.buildDir, 'outputs/checkstyle/checkstyle.xml')
reportXML new File(project.buildDir, 'path/where/you/want/checkstyle.xml')
// Output file for HTML reports, default: new File(project.buildDir, 'outputs/checkstyle/checkstyle.html')
reportHTML new File(project.buildDir, 'path/where/you/want/checkstyle.html')
}
// PMD configuration
pmd {
// Same options as Checkstyle, except for a couple of defaults:
// Configuration file for CheckStyle, default: <project_path>/config/pmd.xml, if non-existent then <project_path>/<module_path>/config/pmd.xml, if non-existent then plugin/src/main/resources/pmd/conf-default.xml
config 'path/to/pmd.xml'
// Output file for XML reports, default: new File(project.buildDir, 'outputs/pmd/pmd.xml')
reportXML new File(project.buildDir, 'path/where/you/want/pmd.xml')
// Output file for HTML reports, default: new File(project.buildDir, 'outputs/pmd/pmd.html')
reportHTML new File(project.buildDir, 'path/where/you/want/pmd.html')
}
}
Also, if abortOnError
is true
, the browser will open the report for the tool that caused the failure (if your system supports it).
Developed By
The original version of this plugin was developed by:
This fork is owned and maintained by Jorge Antonio Diaz-Benito Soriano.
License
See LICENSE.txt.
Original work licensed under MIT license.