Hey,
Just added a very basic checkstyle configuration to maven. The configuration
file is in parents/checkstyle and it checks just a few very basic things, like
trailing whitespace and tabs where there should be spaces.
I’ve enabled it for a single plugin to just the impact on build time and the
amount of generated errors. Quite considerable, but i hope other parts of the
code are better ;-)
You can enable check style for your plugin by adding the following to your
build plugins config in maven:
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>${cs.checkstyle.version}</version>
<dependencies>
<dependency>
<groupId>org.apache.cloudstack</groupId>
<artifactId>checkstyle</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
</dependencies>
<executions>
<execution>
<phase>process-sources</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
<configuration>
<failsOnError>true</failsOnError>
<configLocation>tooling/checkstyle.xml</configLocation>
<consoleOutput>true</consoleOutput>
<includeTestSourceDirectory>true</includeTestSourceDirectory>
<sourceDirectory>${project.basedir}</sourceDirectory>
<includes>**\/*.java,**\/*.xml,**\/*.ini,**\/*.sh,**\/*.bat</includes>
<excludes>**\/target\/,**\/bin\/</excludes>
</configuration>
</plugin>
For now its voluntary, but i would like your opinion on making this a mandatory
part of the build process. Meaning a compile with not succeed when check style
reports errors.
Cheers,
Hugo