Skip to content

Commit

Permalink
Merge pull request #9 from ZenHarbinger/feature/checkstyle
Browse files Browse the repository at this point in the history 
Added checkstyle
  • Loading branch information
@ZenHarbinger
ZenHarbinger authored Jan 23, 2017
2 parents bffada0 + 4c49d69 commit 177fed5
Show file tree
Hide file tree
Showing 85 changed files with 903 additions and 622 deletions.
2 changes: 1 addition & 1 deletion circle.yml
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
test:
override:
- mvn clean cobertura:cobertura
- mvn -DskipTests=false clean cobertura:cobertura
post:
- bash <(curl -s https://codecov.io/bash)
2 changes: 1 addition & 1 deletion codecov.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ comment:
coverage:
precision: 2
range:
- 70.0
- 40.0
- 100.0
round: down
status:
Expand Down
240 changes: 240 additions & 0 deletions config/checkstyle/checkstyle.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,240 @@
<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">

<!--
Checkstyle configuration that checks the sun coding conventions from:
- the Java Language Specification at
http://java.sun.com/docs/books/jls/second_edition/html/index.html
- the Sun Code Conventions at http://java.sun.com/docs/codeconv/
- the Javadoc guidelines at
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
- the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
- some best practices
Checkstyle is very configurable. Be sure to read the documentation at
http://checkstyle.sf.net (or in your downloaded distribution).
Most Checks are configurable, be sure to consult the documentation.
To completely disable a check, just comment it out or delete it from the file.
Finally, it is worth reading the documentation.
-->

<module name="Checker">
<!--
If you set the basedir property below, then all reported file
names will be relative to the specified directory. See
http://checkstyle.sourceforge.net/5.x/config.html#Checker
<property name="basedir" value="${basedir}"/>
-->

<property name="fileExtensions" value="java"/>

<!-- Part of turning off indivial checks: -->
<!-- http://stackoverflow.com/questions/4023185/how-to-disable-a-particular-checkstyle-rule-for-a-particular-line-of-code -->
<module name="SuppressWarningsFilter" />

<!-- Checks that a package-info.java file exists for each package. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
<!-- <module name="JavadocPackage"> -->
<!-- <property name="allowLegacy" value="true"/> --><!-- Allow package.html in addition to package-info.java -->
<!-- </module> -->

<!-- Checks whether files end with a new line. -->
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
<!--<module name="NewlineAtEndOfFile"/>-->

<!-- Checks that property files contain the same keys. -->
<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
<module name="Translation"/>

<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
<module name="FileLength">
<property name="max" value="3500"/>
</module>

<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<!--<module name="FileTabCharacter"/>-->

<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<module name="RegexpSingleline">
<property name="format" value="\s+$"/>
<property name="minimum" value="0"/>
<property name="maximum" value="0"/>
<property name="message" value="Line has trailing spaces."/>
</module>

<!-- Checks for Headers -->
<!-- See http://checkstyle.sf.net/config_header.html -->
<!-- <module name="Header"> -->
<!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
<!-- <property name="fileExtensions" value="java"/> -->
<!-- </module> -->

<module name="TreeWalker">

<!-- Part of turning off indivial checks: -->
<!-- http://stackoverflow.com/questions/5761188/checkstyle-suppressioncommentfilter-not-ignoring-specified-rule/5764666#5764666 -->
<module name="FileContentsHolder"/>
<module name="SuppressWarningsHolder" />

<!-- Checks for Javadoc comments. -->
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
<!--<module name="JavadocMethod"/> This is just too whiny for now. -->
<!-- <module name="JavadocType"/> -->
<!--
<module name="JavadocVariable">
<property name="scope" value="package"/>
</module>
-->
<module name="JavadocStyle"/>


<!-- Checks for Naming Conventions. -->
<!-- See http://checkstyle.sf.net/config_naming.html -->
<module name="ConstantName" />
<module name="LocalFinalVariableName" />
<module name="LocalVariableName" />
<module name="MemberName" />
<module name="MethodName"/>
<module name="PackageName"/>
<module name="ParameterName" />
<module name="StaticVariableName" />
<module name="TypeName"/>


<!-- Checks for imports -->
<!-- See http://checkstyle.sf.net/config_import.html -->
<module name="AvoidStarImport"/>
<module name="IllegalImport"/>
<module name="RedundantImport"/>
<module name="UnusedImports"/>


<!-- Checks for Size Violations. -->
<!-- See http://checkstyle.sf.net/config_sizes.html -->
<!-- TODO: lower this value -->
<module name="LineLength">
<property name="max" value="300"/>
</module>
<!-- <module name="MethodLength">
<property name="max" value="300"/>
</module> -->
<!-- <module name="ParameterNumber">
<property name="max" value="9"/>
<property name="ignoreOverriddenMethods" value="true"/>
</module> -->


<!-- Checks for whitespace -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
<module name="EmptyForIteratorPad"/>
<module name="GenericWhitespace"/>
<module name="MethodParamPad"/>
<module name="NoWhitespaceAfter"/>
<module name="NoWhitespaceBefore"/>
<module name="OperatorWrap" />
<module name="ParenPad"/>
<module name="TypecastParenPad"/>
<module name="WhitespaceAround"/>


<!-- Modifier Checks -->
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
<module name="ModifierOrder"/>
<module name="RedundantModifier"/>


<!-- Checks for blocks. You know, those {}'s -->
<!-- See http://checkstyle.sf.net/config_blocks.html -->
<module name="AvoidNestedBlocks"/>
<module name="EmptyBlock"/>
<module name="LeftCurly"/>
<module name="NeedBraces"> <!-- Allow stuff like "while (doSomething(minus-minus-count));" -->
<!-- <property name="allowEmptyLoopBody" value="true"/> -->
</module>
<module name="RightCurly"> <!-- Right curlies should be alone in if/else -->
<property name="option" value="alone"/>
<property name="tokens" value="LITERAL_ELSE, METHOD_DEF"/>
</module>

<!-- Checks for common coding problems -->
<!-- See http://checkstyle.sf.net/config_coding.html -->
<!--<module name="AvoidInlineConditionals"/>-->
<module name="DefaultComesLast"/>
<module name="DeclarationOrder"/>
<module name="CovariantEquals"/>
<module name="EmptyStatement"/>
<module name="EqualsHashCode"/>
<module name="EqualsAvoidNull"/>
<!-- Completely overridden since it's common in Java to do e.g. this.foo = foo;
<module name="HiddenField">
<property name="ignoreSetter" value="true" />
<property name="ignoreConstructorParameter" value="true" />
</module>
-->
<module name="IllegalInstantiation"/>
<!--<module name="InnerAssignment"/> -->
<!--<module name="MagicNumber"/> -->
<!--<module name="MissingSwitchDefault"/>-->
<module name="SimplifyBooleanExpression"/>
<module name="SimplifyBooleanReturn"/>
<module name="OneStatementPerLine"/>
<module name="OverloadMethodsDeclarationOrder"/>
<module name="PackageDeclaration"/>
<!-- TODO: lower this value -->
<!-- <module name="ReturnCount">
<property name="max" value="6"/>
</module> -->
<module name="StringLiteralEquality"/>
<module name="VariableDeclarationUsageDistance">
<!-- <property name="allowedDistance" value="7"/> -->
<!-- NOTE: flexible on this value -->
<property name="allowedDistance" value="5"/>
</module>
<!-- <module name="UnnecessaryParentheses"/> -->

<!-- Checks for class design -->
<!-- See http://checkstyle.sf.net/config_design.html -->
<!--<module name="DesignForExtension"/>-->
<module name="FinalClass"/>
<module name="HideUtilityClassConstructor"/>
<!--Allow constant interfaces -->
<!-- <module name="InterfaceIsType"/> -->
<module name="VisibilityModifier">
<property name="protectedAllowed" value="true"/>
<property name="packageAllowed" value="true"/>
</module>


<!-- Miscellaneous other checks. -->
<!-- See http://checkstyle.sf.net/config_misc.html -->
<module name="ArrayTypeStyle"/>
<module name="OuterTypeFilename"/>
<!--<module name="FinalParameters"/>-->
<module name="TodoComment"/>
<module name="UpperEll"/>
</module>

<module name="Translation" />

<module name="SuppressionFilter">
<property name="file" value="config/checkstyle/propEditorSuppressions.xml"/>
</module>
<module name="SuppressionCommentFilter" />
<module name="SuppressWithNearbyCommentFilter" />
</module>
8 changes: 8 additions & 0 deletions config/checkstyle/propEditorSuppressions.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8" ?>

<!DOCTYPE suppressions PUBLIC
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
<suppressions>
<suppress files=".*src[\\/]test[\\/].*" checks="[a-zA-Z0-9]*"/>
</suppressions>
32 changes: 31 additions & 1 deletion pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,8 +101,37 @@
</build>
</profile>
</profiles>
<build>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>2.17</version>
<executions>
<execution>
<id>validate</id>
<phase>validate</phase>
<configuration>
<configLocation>config/checkstyle/checkstyle.xml</configLocation>
<encoding>UTF-8</encoding>
<consoleOutput>true</consoleOutput>
<failsOnError>true</failsOnError>
<linkXRef>false</linkXRef>
</configuration>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.19.1</version>
<configuration>
<skipTests>${skipTests}</skipTests>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
Expand Down Expand Up @@ -234,5 +263,6 @@
<maven.compiler.target>1.6</maven.compiler.target>
<timestamp>${maven.build.timestamp}</timestamp>
<maven.build.timestamp.format>yyyy-MM-dd HH:mm:ss</maven.build.timestamp.format>
<skipTests>true</skipTests>
</properties>
</project>
Loading

0 comments on commit 177fed5

Please sign in to comment.