Permalink
Browse files

Better configuration of Maven Checkstyle.

Adds custom configuration of style_checks.xml, tried to fit it to current style.

Additionally, adding <reportSets> element works around bug where checkstyle generates an additional aggregate report with duplication of elements.

Down to ~1600 Checkstyle warnings now. Running the eclipse formatter configured from the Checkstyle config reduces it to ~900, mostly naming convention issues and magic numbers.

Signed-off-by: bolte-17 <bolte.17@gmail.com>
  • Loading branch information...
bolte-17 committed Jan 11, 2013
1 parent 93aeea6 commit e8f5dc9736aeac8e2728b269888aa95728aa7e42
Showing with 110 additions and 0 deletions.
  1. +10 −0 pom.xml
  2. +100 −0 style_checks.xml
View
10 pom.xml
@@ -218,6 +218,16 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>2.9.1</version>
+ <configuration>
+ <configLocation>style_checks.xml</configLocation>
+ </configuration>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>checkstyle</report>
+ </reports>
+ </reportSet>
+ </reportSets>
</plugin>
</plugins>
</reporting>
View
@@ -0,0 +1,100 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
+
+<!--
+ This configuration file was written by the eclipse-cs plugin configuration editor
+-->
+<!--
+ Checkstyle-Configuration: Custom Checkstyle
+ Description: none
+-->
+<module name="Checker">
+ <property name="severity" value="warning"/>
+ <module name="TreeWalker">
+ <property name="tabWidth" value="4"/>
+ <module name="LeftCurly">
+ <property name="maxLineLength" value="120"/>
+ </module>
+ <module name="LineLength">
+ <property name="ignorePattern" value="@version|@see|@todo|TODO"/>
+ <property name="max" value="120"/>
+ </module>
+ <module name="MemberName"/>
+ <module name="JavadocMethod">
+ <property name="severity" value="ignore"/>
+ <property name="scope" value="protected"/>
+ <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="warning"/>
+ </module>
+ <module name="JavadocType">
+ <property name="severity" value="ignore"/>
+ <property name="scope" value="protected"/>
+ <property name="allowUnknownTags" value="true"/>
+ <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
+ </module>
+ <module name="JavadocVariable">
+ <property name="severity" value="ignore"/>
+ <property name="scope" value="protected"/>
+ <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="info"/>
+ </module>
+ <module name="ConstantName"/>
+ <module name="LocalFinalVariableName"/>
+ <module name="LocalVariableName"/>
+ <module name="MethodName"/>
+ <module name="PackageName"/>
+ <module name="ParameterName"/>
+ <module name="StaticVariableName"/>
+ <module name="TypeName"/>
+ <module name="AvoidStarImport"/>
+ <module name="IllegalImport"/>
+ <module name="RedundantImport"/>
+ <module name="UnusedImports"/>
+ <module name="MethodLength"/>
+ <module name="ParameterNumber"/>
+ <module name="EmptyForIteratorPad">
+ <property name="option" value="space"/>
+ </module>
+ <module name="OperatorWrap"/>
+ <module name="ParenPad"/>
+ <module name="WhitespaceAfter"/>
+ <module name="WhitespaceAround"/>
+ <module name="ModifierOrder"/>
+ <module name="RedundantModifier"/>
+ <module name="AvoidNestedBlocks"/>
+ <module name="EmptyBlock">
+ <property name="option" value="text"/>
+ </module>
+ <module name="NeedBraces"/>
+ <module name="EmptyStatement"/>
+ <module name="EqualsHashCode"/>
+ <module name="HiddenField">
+ <property name="severity" value="warning"/>
+ <property name="ignoreConstructorParameter" value="true"/>
+ <property name="ignoreSetter" value="true"/>
+ </module>
+ <module name="IllegalInstantiation"/>
+ <module name="InnerAssignment"/>
+ <module name="MagicNumber">
+ <property name="ignoreNumbers" value="-4, -3, -2, -1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 32, 64, 100, 128, 256, 512, 1000, 1024"/>
+ </module>
+ <module name="MissingSwitchDefault"/>
+ <module name="RedundantThrows"/>
+ <module name="SimplifyBooleanExpression"/>
+ <module name="SimplifyBooleanReturn"/>
+ <module name="InterfaceIsType"/>
+ <module name="VisibilityModifier">
+ <property name="packageAllowed" value="true"/>
+ <property name="protectedAllowed" value="true"/>
+ </module>
+ <module name="UpperEll"/>
+ <module name="RightCurly">
+ <property name="tokens" value="LITERAL_CATCH,LITERAL_FINALLY,LITERAL_ELSE"/>
+ </module>
+ </module>
+ <module name="Translation"/>
+ <module name="FileLength"/>
+ <module name="FileTabCharacter">
+ <property name="severity" value="ignore"/>
+ <property name="eachLine" value="true"/>
+ <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
+ </module>
+</module>

0 comments on commit e8f5dc9

Please sign in to comment.