390 lines
14 KiB
XML
390 lines
14 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE module PUBLIC
|
|
"-//Puppy Crawl//DTD Check Configuration 1.3//EN"
|
|
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
|
|
|
|
<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}"/>
|
|
-->
|
|
|
|
<metadata name="com.atlas-sw.eclipse" value="I like Sydney"/>
|
|
|
|
<property name="severity" value="error"/>
|
|
|
|
<property name="fileExtensions" value="java, properties, xml"/>
|
|
|
|
<module name="SuppressionFilter">
|
|
<property name="file" value="${checkstyle.suppressions.file}"/>
|
|
</module>
|
|
|
|
<module name="JavadocPackage">
|
|
<property name="allowLegacy" value="false"/>
|
|
</module>
|
|
|
|
<module name="Translation">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
|
|
<module name="FileTabCharacter">
|
|
<property name="eachLine" value="false"/>
|
|
</module>
|
|
|
|
<module name="FileLength">
|
|
<property name="fileExtensions" value="java"/>
|
|
</module>
|
|
|
|
<module name="NewlineAtEndOfFile"/>
|
|
|
|
<module name="Header">
|
|
<property name="headerFile" value="${checkstyle.header.file}"/>
|
|
<property name="fileExtensions" value="java"/>
|
|
<property name="id" value="header"/>
|
|
</module>
|
|
|
|
<module name="RegexpSingleline">
|
|
<property name="format" value="\s+$"/>
|
|
<property name="minimum" value="0"/>
|
|
<property name="maximum" value="0"/>
|
|
</module>
|
|
|
|
<module name="RegexpMultiline"/>
|
|
<module name="RegexpMultiline">
|
|
<property name="format" value="\r?\n[\t ]*\r?\n[\t ]*\r?\n"/>
|
|
<property name="fileExtensions" value="java,xml,properties"/>
|
|
<property name="message" value="Unnecessary consecutive lines"/>
|
|
</module>
|
|
|
|
<module name="RegexpSingleline">
|
|
<property name="format" value="/\*\* +\p{javaLowerCase}"/>
|
|
<property name="fileExtensions" value="java"/>
|
|
<property name="message" value="First sentence in a comment should start with a capital letter"/>
|
|
</module>
|
|
<module name="RegexpMultiline">
|
|
<property name="format" value="/\*\*\W+\* +\p{javaLowerCase}"/>
|
|
<property name="fileExtensions" value="java"/>
|
|
<property name="message" value="First sentence in a comment should start with a capital letter"/>
|
|
</module>
|
|
|
|
<module name="RegexpHeader">
|
|
<property name="headerFile" value="${checkstyle.regexp.header.file}"/>
|
|
<property name="fileExtensions" value="java"/>
|
|
</module>
|
|
|
|
<module name="UniqueProperties"/>
|
|
|
|
<module name="TreeWalker">
|
|
<property name="tabWidth" value="4"/>
|
|
|
|
<module name="AvoidStarImport"/>
|
|
<module name="ConstantName"/>
|
|
<module name="EmptyBlock">
|
|
<property name="option" value="text"/>
|
|
</module>
|
|
<module name="EmptyForIteratorPad"/>
|
|
<module name="EqualsHashCode"/>
|
|
<module name="OneStatementPerLine"/>
|
|
|
|
<!-- module name="IllegalCatch"/ -->
|
|
<module name="ImportControl">
|
|
<property name="file" value="${checkstyle.importcontrol.file}"/>
|
|
</module>
|
|
<module name="ImportOrder">
|
|
<property name="groups" value="/^javax?\./,org"/>
|
|
<property name="ordered" value="true"/>
|
|
<property name="separated" value="true"/>
|
|
<property name="option" value="top"/>
|
|
<property name="sortStaticImportsAlphabetically" value="true"/>
|
|
</module>
|
|
<module name="CustomImportOrder">
|
|
<property name="customImportOrderRules" value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS"/>
|
|
<property name="specialImportsRegExp" value="org"/>
|
|
<property name="sortImportsInGroupAlphabetically" value="true"/>
|
|
<property name="separateLineBetweenGroups" value="true"/>
|
|
</module>
|
|
|
|
<module name="IllegalImport"/>
|
|
<module name="IllegalInstantiation"/>
|
|
<module name="IllegalThrows"/>
|
|
<module name="InnerAssignment"/>
|
|
<module name="JavadocType">
|
|
<property name="authorFormat" value="\S"/>
|
|
</module>
|
|
<module name="JavadocMethod">
|
|
<property name="allowUndeclaredRTE" value="true"/>
|
|
<property name="allowThrowsTagsForSubclasses" value="true"/>
|
|
<property name="allowMissingPropertyJavadoc" value="true"/>
|
|
</module>
|
|
<module name="JavadocVariable"/>
|
|
<module name="JavadocStyle">
|
|
<property name="scope" value="public"/>
|
|
</module>
|
|
<module name="LeftCurly">
|
|
<property name="maxLineLength" value="100"/>
|
|
</module>
|
|
<module name="OuterTypeNumber"/>
|
|
<module name="LineLength">
|
|
<property name="max" value="100"/>
|
|
<property name="ignorePattern" value="^ *\* *[^ ]+$"/>
|
|
</module>
|
|
<module name="MethodCount">
|
|
<property name="maxTotal" value="35"/>
|
|
</module>
|
|
|
|
<module name="LocalFinalVariableName"/>
|
|
<module name="LocalVariableName"/>
|
|
<module name="MemberName">
|
|
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
|
|
</module>
|
|
<module name="MethodLength"/>
|
|
<module name="MethodName"/>
|
|
<module name="MethodParamPad"/>
|
|
<module name="ModifierOrder"/>
|
|
<module name="NeedBraces"/>
|
|
<module name="NoWhitespaceAfter">
|
|
<property name="tokens" value="ARRAY_INIT"/>
|
|
<property name="tokens" value="BNOT"/>
|
|
<property name="tokens" value="DEC"/>
|
|
<property name="tokens" value="DOT"/>
|
|
<property name="tokens" value="INC"/>
|
|
<property name="tokens" value="LNOT"/>
|
|
<property name="tokens" value="UNARY_MINUS"/>
|
|
<property name="tokens" value="UNARY_PLUS"/>
|
|
<property name="tokens" value="ARRAY_DECLARATOR"/>
|
|
</module>
|
|
|
|
<module name="NoWhitespaceBefore"/>
|
|
<module name="NoWhitespaceBefore">
|
|
<property name="tokens" value="DOT"/>
|
|
<property name="allowLineBreaks" value="true"/>
|
|
</module>
|
|
|
|
<module name="OperatorWrap"/>
|
|
<module name="OperatorWrap">
|
|
<property name="tokens" value="ASSIGN"/>
|
|
<property name="tokens" value="DIV_ASSIGN"/>
|
|
<property name="tokens" value="PLUS_ASSIGN"/>
|
|
<property name="tokens" value="MINUS_ASSIGN"/>
|
|
<property name="tokens" value="STAR_ASSIGN"/>
|
|
<property name="tokens" value="MOD_ASSIGN"/>
|
|
<property name="tokens" value="SR_ASSIGN"/>
|
|
<property name="tokens" value="BSR_ASSIGN"/>
|
|
<property name="tokens" value="SL_ASSIGN"/>
|
|
<property name="tokens" value="BXOR_ASSIGN"/>
|
|
<property name="tokens" value="BOR_ASSIGN"/>
|
|
<property name="tokens" value="BAND_ASSIGN"/>
|
|
<property name="option" value="eol"/>
|
|
</module>
|
|
<module name="PackageName"/>
|
|
<module name="ParameterName">
|
|
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
|
|
</module>
|
|
<module name="ParameterNumber">
|
|
<property name="max" value="9"/>
|
|
<property name="id" value="paramNum"/>
|
|
</module>
|
|
<module name="ParenPad"/>
|
|
<module name="TypecastParenPad"/>
|
|
<module name="RedundantImport"/>
|
|
<module name="RedundantModifier"/>
|
|
<module name="RightCurly">
|
|
<property name="option" value="alone"/>
|
|
</module>
|
|
<module name="SimplifyBooleanExpression"/>
|
|
<module name="SimplifyBooleanReturn"/>
|
|
<module name="StaticVariableName">
|
|
<property name="format" value="^s[A-Z][a-zA-Z0-9]*$"/>
|
|
</module>
|
|
<module name="TypeName"/>
|
|
<module name="UnusedImports">
|
|
<property name="processJavadoc" value="true"/>
|
|
</module>
|
|
<module name="UpperEll"/>
|
|
<module name="VisibilityModifier"/>
|
|
<module name="WhitespaceAfter"/>
|
|
<module name="WhitespaceAround"/>
|
|
<module name="GenericWhitespace"/>
|
|
<module name="FinalClass"/>
|
|
<module name="MissingSwitchDefault"/>
|
|
<module name="MagicNumber"/>
|
|
<module name="Indentation">
|
|
<property name="basicOffset" value="4"/>
|
|
<property name="braceAdjustment" value="0"/>
|
|
<property name="caseIndent" value="4"/>
|
|
</module>
|
|
<module name="ArrayTrailingComma"/>
|
|
<module name="FinalLocalVariable"/>
|
|
<module name="EqualsAvoidNull"/>
|
|
<module name="ParameterAssignment"/>
|
|
|
|
<module name="CyclomaticComplexity"/>
|
|
|
|
<module name="NestedForDepth">
|
|
<property name="max" value="2"/>
|
|
</module>
|
|
<module name="NestedIfDepth">
|
|
<property name="max" value="3"/>
|
|
</module>
|
|
<module name="NestedTryDepth"/>
|
|
<module name="ExplicitInitialization"/>
|
|
<module name="AnnotationUseStyle"/>
|
|
<module name="MissingDeprecated"/>
|
|
<module name="MissingOverride">
|
|
<property name="javaFiveCompatibility" value="true"/>
|
|
</module>
|
|
<module name="PackageAnnotation"/>
|
|
<module name="SuppressWarnings"/>
|
|
<module name="OuterTypeFilename"/>
|
|
<module name="HideUtilityClassConstructor"/>
|
|
<module name="AnnotationLocation"/>
|
|
<module name="AnonInnerLength"/>
|
|
<module name="ArrayTypeStyle"/>
|
|
<module name="AtclauseOrder"/>
|
|
<module name="AvoidNestedBlocks">
|
|
<property name="allowInSwitchCase" value="true"/>
|
|
</module>
|
|
<module name="AvoidStaticImport"/>
|
|
<module name="ClassTypeParameterName"/>
|
|
<module name="CovariantEquals"/>
|
|
<module name="DeclarationOrder"/>
|
|
<module name="DefaultComesLast"/>
|
|
<module name="DescendantToken"/>
|
|
<module name="EmptyCatchBlock"/>
|
|
<module name="EmptyForInitializerPad"/>
|
|
<module name="EmptyLineSeparator">
|
|
<property name="allowNoEmptyLineBetweenFields" value="true"/>
|
|
</module>
|
|
<module name="EmptyStatement"/>
|
|
<module name="FallThrough"/>
|
|
<module name="IllegalTokenText"/>
|
|
<module name="InterfaceIsType"/>
|
|
<module name="InterfaceTypeParameterName"/>
|
|
<module name="MethodTypeParameterName"/>
|
|
<module name="MultipleVariableDeclarations"/>
|
|
<module name="MutableException"/>
|
|
<module name="NoClone"/>
|
|
<module name="NoFinalizer"/>
|
|
<module name="NoLineWrap"/>
|
|
<module name="NonEmptyAtclauseDescription"/>
|
|
<module name="Regexp"/>
|
|
<module name="RegexpSinglelineJava"/>
|
|
<module name="RegexpSinglelineJava">
|
|
<property name="format" value="[^\p{ASCII}]"/>
|
|
<property name="ignoreComments" value="true"/>
|
|
</module>
|
|
<module name="SeparatorWrap">
|
|
<property name="tokens" value="DOT"/>
|
|
<property name="option" value="nl"/>
|
|
</module>
|
|
<module name="SeparatorWrap">
|
|
<property name="tokens" value="COMMA"/>
|
|
<property name="option" value="EOL"/>
|
|
</module>
|
|
<module name="StringLiteralEquality"/>
|
|
<module name="SuperClone"/>
|
|
<module name="SuperFinalize"/>
|
|
<module name="SuppressWarningsHolder"/>
|
|
<module name="ThrowsCount">
|
|
<property name="max" value="2"/>
|
|
</module>
|
|
<module name="TodoComment">
|
|
<property name="format" value="(TODO)|(FIXME)" />
|
|
</module>
|
|
<module name="UncommentedMain"/>
|
|
<module name="UnnecessaryParentheses"/>
|
|
<module name="AbbreviationAsWordInName"/>
|
|
<module name="AvoidEscapedUnicodeCharacters"/>
|
|
<module name="AbstractClassName"/>
|
|
|
|
<module name="BooleanExpressionComplexity">
|
|
<property name="max" value="7"/>
|
|
</module>
|
|
|
|
<module name="CommentsIndentation"/>
|
|
<module name="HiddenField">
|
|
<property name="ignoreConstructorParameter" value="true"/>
|
|
<property name="ignoreSetter" value="true"/>
|
|
<property name="setterCanReturnItsClass" value="true"/>
|
|
</module>
|
|
<module name="InnerTypeLast"/>
|
|
|
|
<module name="ModifiedControlVariable"/>
|
|
<module name="AvoidInlineConditionals"/>
|
|
<module name="IllegalType"/>
|
|
<module name="TrailingComment"/>
|
|
<module name="MultipleStringLiterals"/>
|
|
|
|
<module name="ExecutableStatementCount">
|
|
<property name="max" value="30"/>
|
|
</module>
|
|
|
|
<module name="NPathComplexity"/>
|
|
<module name="JavaNCSS"/>
|
|
|
|
<module name="ClassDataAbstractionCoupling">
|
|
<!-- Default classes are also listed-->
|
|
<property name="excludedClasses" value="boolean, byte, char, double, float, int, long, short, void, Boolean, Byte, Character, Double, Float, Integer, Long, Short, Void, Object, Class, String, StringBuffer, StringBuilder, ArrayIndexOutOfBoundsException, Exception, RuntimeException, IllegalArgumentException, IllegalStateException, IndexOutOfBoundsException, NullPointerException, Throwable, SecurityException, UnsupportedOperationException, List, ArrayList, Deque, Queue, LinkedList, Set, HashSet, SortedSet, TreeSet, Map, HashMap, SortedMap, TreeMap,
|
|
DetailsAST, CheckstyleException, UnsupportedEncodingException, BuildException, ConversionException, FileNotFoundException, TestException"/>
|
|
</module>
|
|
|
|
<module name="ReturnCount"/>
|
|
<module name="OneTopLevelClass"/>
|
|
<module name="IllegalToken"/>
|
|
|
|
<!--
|
|
All Checks bellow are our futute plan to enforce over our code.
|
|
All of them are activated for integration testing over our code.
|
|
All of them have ignore severity to avoid build failure for now.
|
|
As all violations are resolved Check need to got default severity as all other.
|
|
-->
|
|
<module name="ClassFanOutComplexity">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="FinalParameters">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="JavadocParagraph">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="JavadocTagContinuationIndentation">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="MissingCtor">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="OverloadMethodsDeclarationOrder">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="PackageDeclaration">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="RequireThis">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="SingleLineJavadoc">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="SummaryJavadoc">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="VariableDeclarationUsageDistance">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="WriteTag">
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
<module name="DesignForExtension">
|
|
<!--
|
|
We should postpone DesignForExtension Check enforcement till next major release
|
|
as it will seriously brake backward compatibility with existing usage of our library
|
|
-->
|
|
<property name="severity" value="ignore"/>
|
|
</module>
|
|
|
|
</module>
|
|
</module>
|