-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #62 from DarinJ/checkstyle
Added a reasonable maven checkstyle that should enforce nice code. I…
- Loading branch information
Showing
7 changed files
with
253 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,200 @@ | ||
| <?xml version="1.0"?> | ||
| <!DOCTYPE module PUBLIC | ||
| "-//Puppy Crawl//DTD Check Configuration 1.2//EN" | ||
| "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> | ||
| <!-- | ||
| Checkstyle configuration that checks a modified 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 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}"/> | ||
| --> | ||
| <!--Todo(DarinJ): Uncomment to have warnings instead of errors (Build Success, even if failed checkstyles) --> | ||
| <!--<property name="severity" value="warning"/>--> | ||
|
|
||
| <!-- 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"/> | ||
|
|
||
| <module name="FileLength"/> | ||
|
|
||
| <!-- Following interprets the header file as regular expressions. --> | ||
| <!-- <module name="RegexpHeader"/> --> | ||
|
|
||
| <module name="FileTabCharacter"> | ||
| <property name="eachLine" value="true"/> | ||
| </module> | ||
|
|
||
| <module name="RegexpSingleline"> | ||
| <!-- \s matches whitespace character, $ matches end of line. --> | ||
| <property name="format" value="\s+$"/> | ||
| <property name="message" value="Line has trailing spaces."/> | ||
| </module> | ||
|
|
||
| <module name="TreeWalker"> | ||
|
|
||
| <property name="cacheFile" value="${checkstyle.cache.file}"/> | ||
|
|
||
| <!-- required for SuppressWarningsFilter (and other Suppress* rules not used here) --> | ||
| <!-- see http://checkstyle.sourceforge.net/config_annotation.html#SuppressWarningsHolder --> | ||
| <module name="SuppressWarningsHolder"/> | ||
|
|
||
| <!-- Checks for Javadoc comments. --> | ||
| <!-- See http://checkstyle.sf.net/config_javadoc.html --> | ||
| <!-- <module name="JavadocMethod"/> | ||
| <module name="JavadocType"/> | ||
| <module name="JavadocVariable"/> | ||
| <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 Headers --> | ||
| <!-- See http://checkstyle.sf.net/config_header.html --> | ||
| <!-- <module name="Header"> --> | ||
| <!-- The follow property value demonstrates the ability --> | ||
| <!-- to have access to ANT properties. In this case it uses --> | ||
| <!-- the ${basedir} property to allow Checkstyle to be run --> | ||
| <!-- from any directory within a project. See property --> | ||
| <!-- expansion, --> | ||
| <!-- http://checkstyle.sf.net/config.html#properties --> | ||
| <!-- <property --> | ||
| <!-- name="headerFile" --> | ||
| <!-- value="${basedir}/java.header"/> --> | ||
| <!-- </module> --> | ||
|
|
||
|
|
||
| <!-- Checks for imports --> | ||
| <!-- See http://checkstyle.sf.net/config_import.html --> | ||
| <!-- Todo(DarinJ): add back AvoidStarImport --> | ||
| <!-- <module name="AvoidStarImport"/> --> | ||
| <module name="IllegalImport"/> <!-- defaults to sun.* packages --> | ||
| <module name="RedundantImport"/> | ||
| <module name="UnusedImports"/> | ||
|
|
||
|
|
||
| <!-- Checks for Size Violations. --> | ||
| <!-- See http://checkstyle.sf.net/config_sizes.html --> | ||
| <!-- Todo(DarinJ): add back LineLength --> | ||
| <!-- <module name="LineLength"/> --> | ||
| <!-- Todo(DarinJ): add back MethodLength --> | ||
| <!-- <module name="MethodLength"/> --> | ||
| <module name="ParameterNumber"/> | ||
|
|
||
|
|
||
| <!-- Checks for whitespace --> | ||
| <!-- See http://checkstyle.sf.net/config_whitespace.html --> | ||
| <module name="EmptyForIteratorPad"/> | ||
| <module name="MethodParamPad"/> | ||
| <module name="NoWhitespaceAfter"/> | ||
| <module name="NoWhitespaceBefore"/> | ||
| <!-- <module name="OperatorWrap"/> --> | ||
| <module name="ParenPad"/> | ||
| <module name="TypecastParenPad"/> | ||
| <module name="WhitespaceAfter"/> | ||
| <module name="WhitespaceAround"/> | ||
|
|
||
| <!--Indentation based off google styleguide --> | ||
| <module name="Indentation"> | ||
| <property name="basicOffset" value="2"/> | ||
| <property name="braceAdjustment" value="0"/> | ||
| <property name="caseIndent" value="2"/> | ||
| <property name="throwsIndent" value="4"/> | ||
| <property name="lineWrappingIndentation" value="4"/> | ||
| <property name="arrayInitIndent" value="2"/> | ||
| </module> | ||
|
|
||
| <!-- 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"/> | ||
| <module name="RightCurly"/> | ||
|
|
||
| <!-- Checks for common coding problems --> | ||
| <!-- See http://checkstyle.sf.net/config_coding.html --> | ||
| <!-- Todo(DarinJ): add back AvoidInlineConditional??? used well maybe leave? --> | ||
| <!-- <module name="AvoidInlineConditionals"/> --> | ||
| <module name="EmptyStatement"/> | ||
| <module name="EqualsHashCode"/> | ||
| <!-- <module name="HiddenField"/> --> | ||
| <module name="IllegalInstantiation"/> | ||
| <module name="InnerAssignment"/> | ||
| <!-- Todo(DarinJ): add back MagicNumbe --> | ||
| <!-- <module name="MagicNumber"/> --> | ||
| <module name="MissingSwitchDefault"/> | ||
| <module name="SimplifyBooleanExpression"/> | ||
| <module name="SimplifyBooleanReturn"/> | ||
|
|
||
| <!-- Checks for class design --> | ||
| <!-- See http://checkstyle.sf.net/config_design.html --> | ||
| <!--<module name="DesignForExtension"/> --> | ||
| <module name="FinalClass"/> | ||
| <module name="HideUtilityClassConstructor"/> | ||
| <module name="InterfaceIsType"/> | ||
| <!-- <module name="VisibilityModifier"/> --> | ||
|
|
||
| <!-- Miscellaneous other checks. --> | ||
| <!-- See http://checkstyle.sf.net/config_misc.html --> | ||
| <module name="ArrayTypeStyle"/> | ||
| <!--<module name="FinalParameters"/>--> | ||
| <module name="TodoComment"/> | ||
| <module name="UpperEll"/> | ||
|
|
||
| </module> | ||
|
|
||
| <!-- Support @SuppressWarnings (added in Checkstyle 5.7) --> | ||
| <!-- see http://checkstyle.sourceforge.net/config.html#SuppressWarningsFilter --> | ||
| <module name="SuppressWarningsFilter"/> | ||
|
|
||
| <!-- Checks properties file for a duplicated properties. --> | ||
| <!-- See http://checkstyle.sourceforge.net/config_misc.html#UniqueProperties --> | ||
| <module name="UniqueProperties"/> | ||
|
|
||
| </module> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.