checkstyle plugin definition refactoring
Nikita Koksharov
5 months ago
parent
aaf46e02b2
commit
abcc4646d3
@ -1,288 +0,0 @@
|
|||||||
<?xml version="1.0"?>
|
|
||||||
<!--
|
|
||||||
/*
|
|
||||||
* Copyright 2001-2004 The Apache Software Foundation.
|
|
||||||
*
|
|
||||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
||||||
* you may not use this file except in compliance with the License.
|
|
||||||
* You may obtain a copy of the License at
|
|
||||||
*
|
|
||||||
* http://www.apache.org/licenses/LICENSE-2.0
|
|
||||||
*
|
|
||||||
* Unless required by applicable law or agreed to in writing, software
|
|
||||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
||||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
||||||
* See the License for the specific language governing permissions and
|
|
||||||
* limitations under the License.
|
|
||||||
*/
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!DOCTYPE module PUBLIC
|
|
||||||
"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
|
|
||||||
"https://checkstyle.org/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">
|
|
||||||
<property name="charset" value="UTF-8"/>
|
|
||||||
|
|
||||||
<!-- 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="FileTabCharacter">
|
|
||||||
<property name="eachLine" value="true"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="SuppressWarningsFilter" />
|
|
||||||
|
|
||||||
<module name="TreeWalker">
|
|
||||||
<module name="SuppressWarningsHolder" />
|
|
||||||
|
|
||||||
<!-- Checks for Naming Conventions. -->
|
|
||||||
<!-- See http://checkstyle.sf.net/config_naming.html -->
|
|
||||||
<module name="ConstantName">
|
|
||||||
<property name="format" value="^log(ger)?|[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
|
|
||||||
</module>
|
|
||||||
<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> -->
|
|
||||||
|
|
||||||
<!-- Following interprets the header file as regular expressions. -->
|
|
||||||
<!-- <module name="RegexpHeader"/> -->
|
|
||||||
|
|
||||||
|
|
||||||
<!-- Checks for imports -->
|
|
||||||
<!-- See http://checkstyle.sf.net/config_import.html -->
|
|
||||||
<!--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 -->
|
|
||||||
<!--
|
|
||||||
<module name="LineLength">
|
|
||||||
<property name="max" value="110"/>
|
|
||||||
</module>
|
|
||||||
-->
|
|
||||||
<module name="MethodLength"/>
|
|
||||||
<module name="ParameterNumber">
|
|
||||||
<property name="max" value="10"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<!-- Checks for whitespace -->
|
|
||||||
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
|
|
||||||
<module name="EmptyForIteratorPad"/>
|
|
||||||
<module name="MethodParamPad"/>
|
|
||||||
<module name="NoWhitespaceBefore"/>
|
|
||||||
<module name="OperatorWrap">
|
|
||||||
<property name="tokens" value="QUESTION, COLON, EQUAL, NOT_EQUAL, DIV, MINUS, STAR, MOD, SR, BSR, GE, GT, SL, LE, LT, BXOR, BOR, LOR, BAND, LAND, TYPE_EXTENSION_AND, LITERAL_INSTANCEOF"/>
|
|
||||||
</module>
|
|
||||||
<module name="ParenPad"/>
|
|
||||||
<module name="TypecastParenPad"/>
|
|
||||||
<module name="WhitespaceAfter"/>
|
|
||||||
<!--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">
|
|
||||||
<property name="allowInSwitchCase" value="true"/>
|
|
||||||
</module>
|
|
||||||
<module name="EmptyBlock"/>
|
|
||||||
<module name="LeftCurly"/>
|
|
||||||
<module name="NeedBraces">
|
|
||||||
<property name="tokens" value=" LITERAL_DO,LITERAL_FOR,LITERAL_WHILE"/>
|
|
||||||
</module>
|
|
||||||
<module name="RightCurly"/>
|
|
||||||
|
|
||||||
|
|
||||||
<!-- Checks for common coding problems -->
|
|
||||||
<!-- See http://checkstyle.sf.net/config_coding.html -->
|
|
||||||
<module name="ArrayTrailingComma"/>
|
|
||||||
<module name="AvoidInlineConditionals"/>
|
|
||||||
<module name="CovariantEquals"/>
|
|
||||||
<!-- MY FAVOURITE -->
|
|
||||||
<module name="EmptyStatement"/>
|
|
||||||
<module name="EqualsHashCode"/>
|
|
||||||
<module name="EqualsAvoidNull"/>
|
|
||||||
<!--module name="HiddenField"/-->
|
|
||||||
<module name="IllegalInstantiation"/>
|
|
||||||
<!--module name="IllegalThrows"/-->
|
|
||||||
<module name="InnerAssignment"/>
|
|
||||||
<module name="MultipleVariableDeclarations"/>
|
|
||||||
<!--module name="MagicNumber"/-->
|
|
||||||
<module name="SimplifyBooleanExpression"/>
|
|
||||||
<module name="SimplifyBooleanReturn"/>
|
|
||||||
<module name="StringLiteralEquality"/>
|
|
||||||
<module name="NestedForDepth">
|
|
||||||
<property name="max" value="2"/>
|
|
||||||
</module>
|
|
||||||
<module name="NestedIfDepth">
|
|
||||||
<property name="max" value="3"/>
|
|
||||||
</module>
|
|
||||||
<module name="NestedTryDepth"/>
|
|
||||||
<module name="NoClone"/>
|
|
||||||
<module name="NoFinalizer"/>
|
|
||||||
<module name="OneStatementPerLine"/>
|
|
||||||
<module name="IllegalCatch">
|
|
||||||
<property name="illegalClassNames" value=" java.lang.Throwable, java.lang.RuntimeException"/>
|
|
||||||
</module>
|
|
||||||
<module name="FallThrough"/>
|
|
||||||
<module name="UnnecessaryParentheses">
|
|
||||||
<property name="tokens" value="IDENT"/>
|
|
||||||
<property name="tokens" value="NUM_DOUBLE"/>
|
|
||||||
<property name="tokens" value="NUM_FLOAT"/>
|
|
||||||
<property name="tokens" value="NUM_INT"/>
|
|
||||||
<property name="tokens" value="NUM_LONG"/>
|
|
||||||
<property name="tokens" value="STRING_LITERAL"/>
|
|
||||||
<property name="tokens" value="LITERAL_NULL"/>
|
|
||||||
<property name="tokens" value="LITERAL_FALSE"/>
|
|
||||||
<property name="tokens" value="LITERAL_TRUE"/>
|
|
||||||
<property name="tokens" value="ASSIGN"/>
|
|
||||||
<property name="tokens" value="BAND_ASSIGN"/>
|
|
||||||
<property name="tokens" value="BOR_ASSIGN"/>
|
|
||||||
<property name="tokens" value="BSR_ASSIGN"/>
|
|
||||||
<property name="tokens" value="BXOR_ASSIGN"/>
|
|
||||||
<property name="tokens" value="DIV_ASSIGN"/>
|
|
||||||
<property name="tokens" value="MINUS_ASSIGN"/>
|
|
||||||
<property name="tokens" value="MOD_ASSIGN"/>
|
|
||||||
<property name="tokens" value="PLUS_ASSIGN"/>
|
|
||||||
<property name="tokens" value="SL_ASSIGN"/>
|
|
||||||
<property name="tokens" value="SR_ASSIGN"/>
|
|
||||||
<property name="tokens" value="STAR_ASSIGN"/>
|
|
||||||
<property name="tokens" value="LAMBDA"/>
|
|
||||||
<property name="tokens" value="TEXT_BLOCK_LITERAL_BEGIN"/>
|
|
||||||
<property name="tokens" value="LOR"/>
|
|
||||||
<property name="tokens" value="LITERAL_INSTANCEOF"/>
|
|
||||||
<property name="tokens" value="GT"/>
|
|
||||||
<property name="tokens" value="LT"/>
|
|
||||||
<property name="tokens" value="GE"/>
|
|
||||||
<property name="tokens" value="LE"/>
|
|
||||||
<property name="tokens" value="EQUAL"/>
|
|
||||||
<property name="tokens" value="NOT_EQUAL"/>
|
|
||||||
<property name="tokens" value="UNARY_MINUS"/>
|
|
||||||
<property name="tokens" value="UNARY_PLUS"/>
|
|
||||||
<property name="tokens" value="INC"/>
|
|
||||||
<property name="tokens" value="DEC"/>
|
|
||||||
<property name="tokens" value="LNOT"/>
|
|
||||||
<property name="tokens" value="BNOT"/>
|
|
||||||
<property name="tokens" value="POST_INC"/>
|
|
||||||
<property name="tokens" value="POST_DEC"/>
|
|
||||||
<!--
|
|
||||||
<property name="tokens" value="LAND"/>
|
|
||||||
-->
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<!--
|
|
||||||
<module name="UnnecessarySemicolonAfterOuterTypeDeclaration"/>
|
|
||||||
<module name="UnnecessarySemicolonAfterTypeMemberDeclaration"/>
|
|
||||||
<module name="UnnecessarySemicolonInEnumeration"/>
|
|
||||||
<module name="UnnecessarySemicolonInTryWithResources"/>
|
|
||||||
<module name="UnusedLocalVariable"/>
|
|
||||||
-->
|
|
||||||
<!--module name="FinalLocalVariable"/-->
|
|
||||||
|
|
||||||
<!-- Checks for class design -->
|
|
||||||
<!-- See http://checkstyle.sf.net/config_design.html -->
|
|
||||||
<!--module name="DesignForExtension"/-->
|
|
||||||
<module name="FinalClass"/>
|
|
||||||
<!--module name="HideUtilityClassConstructor"/-->
|
|
||||||
<module name="VisibilityModifier">
|
|
||||||
<property name="packageAllowed" value="true"/>
|
|
||||||
<property name="protectedAllowed" value="true"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<!-- Miscellaneous other checks. -->
|
|
||||||
<!-- See http://checkstyle.sf.net/config_misc.html -->
|
|
||||||
<module name="ArrayTypeStyle"/>
|
|
||||||
<module name="Regexp">
|
|
||||||
<property name="format" value="System\.(out)|(err)\.print(ln)?\("/>
|
|
||||||
<property name="illegalPattern" value="true"/>
|
|
||||||
</module>
|
|
||||||
<module name="Regexp">
|
|
||||||
<property name="format" value="System\.exit"/>
|
|
||||||
<property name="illegalPattern" value="true"/>
|
|
||||||
</module>
|
|
||||||
<module name="Regexp">
|
|
||||||
<property name="format" value="\.printStacktrace"/>
|
|
||||||
<property name="illegalPattern" value="true"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<!--module name="FinalParameters"/-->
|
|
||||||
<!--module name="GenericIllegalRegexp">
|
|
||||||
<property name="format" value="\s+$"/>
|
|
||||||
<property name="message" value="Line has trailing spaces."/>
|
|
||||||
</module-->
|
|
||||||
<!--module name="TodoComment"/-->
|
|
||||||
<module name="UpperEll"/>
|
|
||||||
|
|
||||||
<!--
|
|
||||||
<module name="BooleanExpressionComplexity"/>
|
|
||||||
-->
|
|
||||||
</module>
|
|
||||||
|
|
||||||
<module name="SuppressionFilter">
|
|
||||||
<property name="file" value="${checkstyle.config.path}/suppressions.xml"/>
|
|
||||||
<property name="optional" value="false"/>
|
|
||||||
</module>
|
|
||||||
|
|
||||||
</module>
|
|
||||||
Loading…
Reference in New Issue