applied style formatting to checkstyle config file.
parent
a3dd031a49
commit
aa4ae1ef52
140
checkstyle.xml
140
checkstyle.xml
|
@ -3,9 +3,8 @@
|
||||||
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
|
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
|
||||||
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
|
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
|
||||||
|
|
||||||
<!-- This is a checkstyle configuration file. For descriptions of
|
<!-- This is a checkstyle configuration file. For descriptions of what the
|
||||||
what the following rules do, please see the checkstyle configuration
|
following rules do, please see the checkstyle configuration page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
page at http://checkstyle.sourceforge.net/config.html -->
|
|
||||||
|
|
||||||
<!-- Adapted from google-api-java-client -->
|
<!-- Adapted from google-api-java-client -->
|
||||||
|
|
||||||
|
@ -16,8 +15,7 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="RegexpSingleline">
|
<module name="RegexpSingleline">
|
||||||
<!-- Checks that FIXME is not used in comments. TODO is preferred.
|
<!-- Checks that FIXME is not used in comments. TODO is preferred. -->
|
||||||
-->
|
|
||||||
<property name="format" value="((//.*)|(\*.*))FIXME"/>
|
<property name="format" value="((//.*)|(\*.*))FIXME"/>
|
||||||
<property name="message" value='TODO is preferred to FIXME.'/>
|
<property name="message" value='TODO is preferred to FIXME.'/>
|
||||||
</module>
|
</module>
|
||||||
|
@ -25,11 +23,7 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
<!-- All Java AST specific tests live under TreeWalker module. -->
|
<!-- All Java AST specific tests live under TreeWalker module. -->
|
||||||
<module name="TreeWalker">
|
<module name="TreeWalker">
|
||||||
|
|
||||||
<!--
|
<!-- IMPORT CHECKS -->
|
||||||
|
|
||||||
IMPORT CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<module name="RedundantImport">
|
<module name="RedundantImport">
|
||||||
<!-- Checks for redundant import statements. -->
|
<!-- Checks for redundant import statements. -->
|
||||||
|
@ -45,11 +39,7 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
<property name="tokens" value="STATIC_IMPORT, IMPORT"/>
|
<property name="tokens" value="STATIC_IMPORT, IMPORT"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<!--
|
<!-- JAVADOC CHECKS -->
|
||||||
|
|
||||||
JAVADOC CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- Checks for Javadoc comments. -->
|
<!-- Checks for Javadoc comments. -->
|
||||||
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
|
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
|
||||||
|
@ -58,27 +48,20 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
<property name="severity" value="warning"/>
|
<property name="severity" value="warning"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<!--
|
<!-- NAMING CHECKS -->
|
||||||
|
|
||||||
NAMING CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- Item 38 - Adhere to generally accepted naming conventions -->
|
<!-- Item 38 - Adhere to generally accepted naming conventions -->
|
||||||
|
|
||||||
<module name="PackageName">
|
<module name="PackageName">
|
||||||
<!-- Validates identifiers for package names against the
|
<!-- Validates identifiers for package names against the supplied expression. -->
|
||||||
supplied expression. -->
|
|
||||||
<!-- Here the default checkstyle rule restricts package name parts to
|
<!-- Here the default checkstyle rule restricts package name parts to
|
||||||
seven characters, this is not in line with common practice at Google.
|
seven characters, this is not in line with common practice at Google. -->
|
||||||
-->
|
|
||||||
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$"/>
|
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$"/>
|
||||||
<property name="severity" value="warning"/>
|
<property name="severity" value="warning"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="TypeNameCheck">
|
<module name="TypeNameCheck">
|
||||||
<!-- Validates static, final fields against the
|
<!-- Validates static, final fields against the expression "^[A-Z][a-zA-Z0-9]*$". -->
|
||||||
expression "^[A-Z][a-zA-Z0-9]*$". -->
|
|
||||||
<metadata name="altname" value="TypeName"/>
|
<metadata name="altname" value="TypeName"/>
|
||||||
<property name="severity" value="warning"/>
|
<property name="severity" value="warning"/>
|
||||||
</module>
|
</module>
|
||||||
|
@ -98,8 +81,8 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="StaticVariableNameCheck">
|
<module name="StaticVariableNameCheck">
|
||||||
<!-- Validates static, non-final fields against the supplied
|
<!-- Validates static, non-final fields against the supplied expression
|
||||||
expression "^[a-z][a-zA-Z0-9]*_?$". -->
|
"^[a-z][a-zA-Z0-9]*_?$". -->
|
||||||
<metadata name="altname" value="StaticVariableName"/>
|
<metadata name="altname" value="StaticVariableName"/>
|
||||||
<property name="applyToPublic" value="true"/>
|
<property name="applyToPublic" value="true"/>
|
||||||
<property name="applyToProtected" value="true"/>
|
<property name="applyToProtected" value="true"/>
|
||||||
|
@ -128,40 +111,35 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="ParameterName">
|
<module name="ParameterName">
|
||||||
<!-- Validates identifiers for method parameters against the
|
<!-- Validates identifiers for method parameters against the expression
|
||||||
expression "^[a-z][a-zA-Z0-9]*$". -->
|
"^[a-z][a-zA-Z0-9]*$". -->
|
||||||
<property name="severity" value="warning"/>
|
<property name="severity" value="warning"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="LocalFinalVariableName">
|
<module name="LocalFinalVariableName">
|
||||||
<!-- Validates identifiers for local final variables against the
|
<!-- Validates identifiers for local final variables against the expression
|
||||||
expression "^[a-z][a-zA-Z0-9]*$". -->
|
"^[a-z][a-zA-Z0-9]*$". -->
|
||||||
<property name="severity" value="warning"/>
|
<property name="severity" value="warning"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="LocalVariableName">
|
<module name="LocalVariableName">
|
||||||
<!-- Validates identifiers for local variables against the
|
<!-- Validates identifiers for local variables against the expression
|
||||||
expression "^[a-z][a-zA-Z0-9]*$". -->
|
"^[a-z][a-zA-Z0-9]*$". -->
|
||||||
<property name="severity" value="warning"/>
|
<property name="severity" value="warning"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
|
|
||||||
<!--
|
<!-- LENGTH and CODING CHECKS -->
|
||||||
|
|
||||||
LENGTH and CODING CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<module name="LineLength">
|
<module name="LineLength">
|
||||||
<!-- Checks if a line is too long. -->
|
<!-- Checks if a line is too long. -->
|
||||||
<property name="max" value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.max}" default="250"/>
|
<property name="max"
|
||||||
|
value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.max}"
|
||||||
|
default="250"/>
|
||||||
<property name="severity" value="error"/>
|
<property name="severity" value="error"/>
|
||||||
|
|
||||||
<!--
|
<!-- The default ignore pattern exempts the following elements: - import
|
||||||
The default ignore pattern exempts the following elements:
|
statements - long URLs inside comments -->
|
||||||
- import statements
|
|
||||||
- long URLs inside comments
|
|
||||||
-->
|
|
||||||
|
|
||||||
<property name="ignorePattern"
|
<property name="ignorePattern"
|
||||||
value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.ignorePattern}"
|
value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.ignorePattern}"
|
||||||
|
@ -174,22 +152,9 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="RightCurly">
|
<module name="RightCurly">
|
||||||
<!-- Checks right curlies on CATCH, ELSE, and TRY blocks are on
|
<!-- Checks right curlies on CATCH, ELSE, and TRY blocks are on the same
|
||||||
the same line. e.g., the following example is fine:
|
line. e.g., the following example is fine: <pre> if { ... } else </pre> -->
|
||||||
<pre>
|
<!-- This next example is not fine: <pre> if { ... } else </pre> -->
|
||||||
if {
|
|
||||||
...
|
|
||||||
} else
|
|
||||||
</pre>
|
|
||||||
-->
|
|
||||||
<!-- This next example is not fine:
|
|
||||||
<pre>
|
|
||||||
if {
|
|
||||||
...
|
|
||||||
}
|
|
||||||
else
|
|
||||||
</pre>
|
|
||||||
-->
|
|
||||||
<property name="option" value="same"/>
|
<property name="option" value="same"/>
|
||||||
<property name="severity" value="warning"/>
|
<property name="severity" value="warning"/>
|
||||||
</module>
|
</module>
|
||||||
|
@ -197,7 +162,8 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
<!-- Checks for braces around if and else blocks -->
|
<!-- Checks for braces around if and else blocks -->
|
||||||
<module name="NeedBraces">
|
<module name="NeedBraces">
|
||||||
<property name="severity" value="warning"/>
|
<property name="severity" value="warning"/>
|
||||||
<property name="tokens" value="LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO"/>
|
<property name="tokens"
|
||||||
|
value="LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="UpperEll">
|
<module name="UpperEll">
|
||||||
|
@ -208,42 +174,31 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
<module name="FallThrough">
|
<module name="FallThrough">
|
||||||
<!-- Warn about falling through to the next case statement. Similar to
|
<!-- Warn about falling through to the next case statement. Similar to
|
||||||
javac -Xlint:fallthrough, but the check is suppressed if a single-line comment
|
javac -Xlint:fallthrough, but the check is suppressed if a single-line comment
|
||||||
on the last non-blank line preceding the fallen-into case contains 'fall through' (or
|
on the last non-blank line preceding the fallen-into case contains 'fall
|
||||||
some other variants which we don't publicized to promote consistency).
|
through' (or some other variants which we don't publicized to promote consistency). -->
|
||||||
-->
|
|
||||||
<property name="reliefPattern"
|
<property name="reliefPattern"
|
||||||
value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
|
value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
|
||||||
<property name="severity" value="error"/>
|
<property name="severity" value="error"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
|
|
||||||
<!--
|
|
||||||
|
|
||||||
MODIFIERS CHECKS
|
<!-- MODIFIERS CHECKS -->
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<module name="ModifierOrder">
|
<module name="ModifierOrder">
|
||||||
<!-- Warn if modifier order is inconsistent with JLS3 8.1.1, 8.3.1, and
|
<!-- Warn if modifier order is inconsistent with JLS3 8.1.1, 8.3.1, and
|
||||||
8.4.3. The prescribed order is:
|
8.4.3. The prescribed order is: public, protected, private, abstract, static,
|
||||||
public, protected, private, abstract, static, final, transient, volatile,
|
final, transient, volatile, synchronized, native, strictfp -->
|
||||||
synchronized, native, strictfp
|
|
||||||
-->
|
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
|
|
||||||
<!--
|
<!-- WHITESPACE CHECKS -->
|
||||||
|
|
||||||
WHITESPACE CHECKS
|
|
||||||
|
|
||||||
-->
|
|
||||||
|
|
||||||
<module name="WhitespaceAround">
|
<module name="WhitespaceAround">
|
||||||
<!-- Checks that various tokens are surrounded by whitespace.
|
<!-- Checks that various tokens are surrounded by whitespace. This includes
|
||||||
This includes most binary operators and keywords followed
|
most binary operators and keywords followed by regular or curly braces. -->
|
||||||
by regular or curly braces.
|
<property name="tokens"
|
||||||
-->
|
value="ASSIGN, BAND, BAND_ASSIGN, BOR,
|
||||||
<property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR,
|
|
||||||
BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN,
|
BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN,
|
||||||
EQUAL, GE, GT, LAND, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
|
EQUAL, GE, GT, LAND, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
|
||||||
LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
|
LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
|
||||||
|
@ -254,35 +209,30 @@ page at http://checkstyle.sourceforge.net/config.html -->
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="WhitespaceAfter">
|
<module name="WhitespaceAfter">
|
||||||
<!-- Checks that commas, semicolons and typecasts are followed by
|
<!-- Checks that commas, semicolons and typecasts are followed by whitespace. -->
|
||||||
whitespace.
|
|
||||||
-->
|
|
||||||
<property name="tokens" value="COMMA, SEMI, TYPECAST"/>
|
<property name="tokens" value="COMMA, SEMI, TYPECAST"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="NoWhitespaceAfter">
|
<module name="NoWhitespaceAfter">
|
||||||
<!-- Checks that there is no whitespace after various unary operators.
|
<!-- Checks that there is no whitespace after various unary operators.
|
||||||
Linebreaks are allowed.
|
Linebreaks are allowed. -->
|
||||||
-->
|
<property name="tokens"
|
||||||
<property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS,
|
value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
|
||||||
UNARY_PLUS"/>
|
|
||||||
<property name="allowLineBreaks" value="true"/>
|
<property name="allowLineBreaks" value="true"/>
|
||||||
<property name="severity" value="error"/>
|
<property name="severity" value="error"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="NoWhitespaceBefore">
|
<module name="NoWhitespaceBefore">
|
||||||
<!-- Checks that there is no whitespace before various unary operators.
|
<!-- Checks that there is no whitespace before various unary operators.
|
||||||
Linebreaks are allowed.
|
Linebreaks are allowed. -->
|
||||||
-->
|
|
||||||
<property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
|
<property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
|
||||||
<property name="allowLineBreaks" value="true"/>
|
<property name="allowLineBreaks" value="true"/>
|
||||||
<property name="severity" value="error"/>
|
<property name="severity" value="error"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
<module name="ParenPad">
|
<module name="ParenPad">
|
||||||
<!-- Checks that there is no whitespace before close parens or after
|
<!-- Checks that there is no whitespace before close parens or after open
|
||||||
open parens.
|
parens. -->
|
||||||
-->
|
|
||||||
<property name="severity" value="warning"/>
|
<property name="severity" value="warning"/>
|
||||||
</module>
|
</module>
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue