On Jul 21, 2009, at 6:43 AM, Adam Murdoch wrote:
Hi,
I've just checked in a 'code-quality' plugin, which currently adds
Checkstyle and CodeNarc tasks to Java and Groovy projects,
respectively. My plan is that this plugin would later also add
support for tools such as cobertura, PMD, and so on.
I have some questions about which conventions this plugin should
follow. I've just made some stuff up, based on what I've done on
various projects, but I have no idea if they are conventions or not.
Please let me know if you have an opinion on these:
- Where should the config files for these tools live? Currently, the
plugin expected to find them at $projectDir/config/checkstyle.xml
and $projectDir/config/codenarc.xml.
With checkstyle you pretty often need additional configuration files.
So may be $projectDir/config/checkstyle/checkstyle.xml might be a
better choice. We might do it the same for codenarc. If more and more
plugins need
configuration files we might need to come up with some additional
structure.
- Should we provide some default configuration for these tools?
Maybe some named configuration sets?
Our future archetype plugin could either create empty templates or
optionally preconfigured xml files.
- Where should the results go? Currently, they end up in $buildDir/
checkstyle/main.xml, $buildDir/checkstyle/test.xml, $buildDir/
reports/codenarc/main.html, and $buildDir/reports/codenarc/test.html
(there's no checkstyle report, yet, just a results xml file).
I guess that is the simples solution that possibly makes sense. In the
future we might introduce additional layers.
- Should it be possible to ignore violations?
I think so.
(and why?)
Because some users want it :)
But they can disable this behavior already by setting the appropriate
properties, can't they. We could set fail to false but set the default
of maxErrors and maxWarnings to 0.
- Hans
--
Hans Dockter
Gradle Project Manager
http://www.gradle.org
---------------------------------------------------------------------
To unsubscribe from this list, please visit:
http://xircles.codehaus.org/manage_email
