cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From John Kinsella <...@stratosec.co>
Subject Re: checkstyle
Date Mon, 04 Nov 2013 15:28:59 GMT
I think it'd be fairly painful to make it mandatory - maybe see if we can set that as a goal
for 6 months out?

On Nov 4, 2013, at 6:29 AM, Hugo Trippaers <hugo@trippaers.nl<mailto:hugo@trippaers.nl>>
 wrote:

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

Stratosec<http://stratosec.co/> - Compliance as a Service
o: 415.315.9385
@johnlkinsella<http://twitter.com/johnlkinsella>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message