360 lines
16 KiB
XML
360 lines
16 KiB
XML
<?xml version="1.0"?>
|
|
<!DOCTYPE module PUBLIC
|
|
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
|
|
"https://checkstyle.org/dtds/configuration_1_3.dtd">
|
|
|
|
<!--
|
|
Configuration Checkstyle pour UnionFlow
|
|
Basée sur Google Java Style Guide avec adaptations pour UnionFlow
|
|
Objectif : 100% de conformité (zéro violation)
|
|
|
|
@author UnionFlow Team
|
|
@version 1.0
|
|
@since 2025-01-10
|
|
-->
|
|
|
|
<module name="Checker">
|
|
<property name="charset" value="UTF-8"/>
|
|
<property name="severity" value="error"/>
|
|
<property name="fileExtensions" value="java, properties, xml"/>
|
|
|
|
<!-- Suppressions pour les fichiers générés -->
|
|
<module name="SuppressionFilter">
|
|
<property name="file" value="${org.checkstyle.google.suppressionfilter.config}"
|
|
default="checkstyle-suppressions.xml" />
|
|
<property name="optional" value="true"/>
|
|
</module>
|
|
|
|
<!-- Vérifications au niveau des fichiers -->
|
|
<module name="FileTabCharacter">
|
|
<property name="eachLine" value="true"/>
|
|
</module>
|
|
|
|
<module name="LineLength">
|
|
<property name="fileExtensions" value="java"/>
|
|
<property name="max" value="120"/>
|
|
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
|
|
</module>
|
|
|
|
<module name="NewlineAtEndOfFile"/>
|
|
|
|
<!-- Vérifications au niveau des arbres syntaxiques -->
|
|
<module name="TreeWalker">
|
|
|
|
<!-- Annotations -->
|
|
<module name="AnnotationLocation">
|
|
<property name="id" value="AnnotationLocationMostCases"/>
|
|
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
|
|
</module>
|
|
<module name="AnnotationLocation">
|
|
<property name="id" value="AnnotationLocationVariables"/>
|
|
<property name="tokens" value="VARIABLE_DEF"/>
|
|
<property name="allowSamelineMultipleAnnotations" value="true"/>
|
|
</module>
|
|
<module name="AnnotationUseStyle"/>
|
|
<module name="MissingOverride"/>
|
|
|
|
<!-- Blocs -->
|
|
<module name="AvoidNestedBlocks"/>
|
|
<module name="EmptyBlock">
|
|
<property name="option" value="TEXT"/>
|
|
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
|
|
</module>
|
|
<module name="EmptyCatchBlock">
|
|
<property name="exceptionVariableName" value="expected"/>
|
|
</module>
|
|
<module name="LeftCurly"/>
|
|
<module name="NeedBraces"/>
|
|
<module name="RightCurly">
|
|
<property name="id" value="RightCurlySame"/>
|
|
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
|
|
</module>
|
|
<module name="RightCurly">
|
|
<property name="id" value="RightCurlyAlone"/>
|
|
<property name="option" value="alone"/>
|
|
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, STATIC_INIT, INSTANCE_INIT"/>
|
|
</module>
|
|
|
|
<!-- Conception de classe -->
|
|
<module name="FinalClass"/>
|
|
<module name="HideUtilityClassConstructor"/>
|
|
<module name="InterfaceIsType"/>
|
|
<module name="OneTopLevelClass"/>
|
|
<module name="VisibilityModifier">
|
|
<property name="protectedAllowed" value="true"/>
|
|
<property name="packageAllowed" value="true"/>
|
|
</module>
|
|
|
|
<!-- Codage -->
|
|
<module name="ArrayTrailingComma"/>
|
|
<module name="AvoidEscapedUnicodeCharacters">
|
|
<property name="allowEscapesForControlCharacters" value="true"/>
|
|
<property name="allowByTailComment" value="true"/>
|
|
<property name="allowNonPrintableEscapes" value="true"/>
|
|
</module>
|
|
<module name="CovariantEquals"/>
|
|
<module name="DeclarationOrder"/>
|
|
<module name="DefaultComesLast"/>
|
|
<module name="EmptyStatement"/>
|
|
<module name="EqualsAvoidNull"/>
|
|
<module name="EqualsHashCode"/>
|
|
<module name="ExplicitInitialization"/>
|
|
<module name="FallThrough"/>
|
|
<module name="IllegalInstantiation"/>
|
|
<module name="IllegalToken"/>
|
|
<module name="IllegalTokenText">
|
|
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
|
|
<property name="format" value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
|
|
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
|
|
</module>
|
|
<module name="InnerAssignment"/>
|
|
<module name="MagicNumber">
|
|
<property name="ignoreNumbers" value="-1, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 100, 1000"/>
|
|
<property name="ignoreHashCodeMethod" value="true"/>
|
|
<property name="ignoreAnnotation" value="true"/>
|
|
<property name="ignoreFieldDeclaration" value="true"/>
|
|
</module>
|
|
<module name="MissingSwitchDefault"/>
|
|
<module name="ModifiedControlVariable"/>
|
|
<module name="MultipleStringLiterals">
|
|
<property name="allowedDuplicates" value="3"/>
|
|
</module>
|
|
<module name="MultipleVariableDeclarations"/>
|
|
<module name="NoClone"/>
|
|
<module name="NoFinalizer"/>
|
|
<module name="OneStatementPerLine"/>
|
|
<module name="OverloadMethodsDeclarationOrder"/>
|
|
<module name="PackageDeclaration"/>
|
|
<module name="ParameterAssignment"/>
|
|
<module name="RequireThis">
|
|
<property name="checkFields" value="false"/>
|
|
<property name="checkMethods" value="false"/>
|
|
</module>
|
|
<module name="SimplifyBooleanExpression"/>
|
|
<module name="SimplifyBooleanReturn"/>
|
|
<module name="StringLiteralEquality"/>
|
|
<module name="UnnecessaryParentheses"/>
|
|
<module name="VariableDeclarationUsageDistance"/>
|
|
|
|
<!-- Imports -->
|
|
<module name="AvoidStarImport"/>
|
|
<module name="AvoidStaticImport">
|
|
<property name="excludes" value="org.assertj.core.api.Assertions.*,org.junit.jupiter.api.Assertions.*,org.mockito.Mockito.*"/>
|
|
</module>
|
|
<module name="CustomImportOrder">
|
|
<property name="sortImportsInGroupAlphabetically" value="true"/>
|
|
<property name="separateLineBetweenGroups" value="true"/>
|
|
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
|
|
</module>
|
|
<module name="IllegalImport"/>
|
|
<module name="RedundantImport"/>
|
|
<module name="UnusedImports"/>
|
|
|
|
<!-- Javadoc -->
|
|
<module name="AtclauseOrder">
|
|
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
|
|
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
|
|
</module>
|
|
<module name="InvalidJavadocPosition"/>
|
|
<module name="JavadocMethod">
|
|
<property name="allowMissingParamTags" value="false"/>
|
|
<property name="allowMissingReturnTag" value="false"/>
|
|
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
|
|
</module>
|
|
<module name="JavadocParagraph"/>
|
|
<module name="JavadocStyle"/>
|
|
<module name="JavadocTagContinuationIndentation"/>
|
|
<module name="JavadocType"/>
|
|
<module name="MissingJavadocMethod">
|
|
<property name="minLineCount" value="2"/>
|
|
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
|
|
</module>
|
|
<module name="MissingJavadocType"/>
|
|
<module name="NonEmptyAtclauseDescription"/>
|
|
<module name="SingleLineJavadoc">
|
|
<property name="ignoreInlineTags" value="false"/>
|
|
</module>
|
|
<module name="SummaryJavadoc">
|
|
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
|
|
</module>
|
|
|
|
<!-- Métriques -->
|
|
<module name="BooleanExpressionComplexity">
|
|
<property name="max" value="7"/>
|
|
</module>
|
|
<module name="ClassDataAbstractionCoupling">
|
|
<property name="max" value="15"/>
|
|
</module>
|
|
<module name="ClassFanOutComplexity">
|
|
<property name="max" value="25"/>
|
|
</module>
|
|
<module name="CyclomaticComplexity">
|
|
<property name="max" value="15"/>
|
|
</module>
|
|
<module name="JavaNCSS">
|
|
<property name="methodMaximum" value="80"/>
|
|
<property name="classMaximum" value="2000"/>
|
|
</module>
|
|
<module name="NPathComplexity">
|
|
<property name="max" value="200"/>
|
|
</module>
|
|
|
|
<!-- Divers -->
|
|
<module name="ArrayTypeStyle"/>
|
|
<module name="CommentsIndentation"/>
|
|
<module name="Indentation">
|
|
<property name="basicOffset" value="4"/>
|
|
<property name="braceAdjustment" value="0"/>
|
|
<property name="caseIndent" value="4"/>
|
|
<property name="throwsIndent" value="8"/>
|
|
<property name="lineWrappingIndentation" value="8"/>
|
|
<property name="arrayInitIndent" value="4"/>
|
|
</module>
|
|
<module name="OuterTypeFilename"/>
|
|
<module name="TodoComment">
|
|
<property name="format" value="(TODO)|(FIXME)"/>
|
|
</module>
|
|
<module name="TrailingComment"/>
|
|
<module name="UncommentedMain">
|
|
<property name="excludedClasses" value="\.Main$"/>
|
|
</module>
|
|
<module name="UpperEll"/>
|
|
|
|
<!-- Modificateurs -->
|
|
<module name="ModifierOrder"/>
|
|
<module name="RedundantModifier"/>
|
|
|
|
<!-- Conventions de nommage -->
|
|
<module name="AbbreviationAsWordInName">
|
|
<property name="ignoreFinal" value="false"/>
|
|
<property name="allowedAbbreviationLength" value="4"/>
|
|
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF"/>
|
|
</module>
|
|
<module name="ClassTypeParameterName">
|
|
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
|
|
<message key="name.invalidPattern" value="Class type name ''{0}'' must match pattern ''{1}''."/>
|
|
</module>
|
|
<module name="ConstantName"/>
|
|
<module name="InterfaceTypeParameterName">
|
|
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
|
|
<message key="name.invalidPattern" value="Interface type name ''{0}'' must match pattern ''{1}''."/>
|
|
</module>
|
|
<module name="LocalFinalVariableName"/>
|
|
<module name="LocalVariableName">
|
|
<property name="tokens" value="VARIABLE_DEF"/>
|
|
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
|
|
<message key="name.invalidPattern" value="Local variable name ''{0}'' must match pattern ''{1}''."/>
|
|
</module>
|
|
<module name="MemberName">
|
|
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
|
|
<message key="name.invalidPattern" value="Member name ''{0}'' must match pattern ''{1}''."/>
|
|
</module>
|
|
<module name="MethodName">
|
|
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
|
|
<message key="name.invalidPattern" value="Method name ''{0}'' must match pattern ''{1}''."/>
|
|
</module>
|
|
<module name="MethodTypeParameterName">
|
|
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
|
|
<message key="name.invalidPattern" value="Method type name ''{0}'' must match pattern ''{1}''."/>
|
|
</module>
|
|
<module name="PackageName">
|
|
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
|
|
<message key="name.invalidPattern" value="Package name ''{0}'' must match pattern ''{1}''."/>
|
|
</module>
|
|
<module name="ParameterName">
|
|
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
|
|
<message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''."/>
|
|
</module>
|
|
<module name="StaticVariableName"/>
|
|
<module name="TypeName">
|
|
<message key="name.invalidPattern" value="Type name ''{0}'' must match pattern ''{1}''."/>
|
|
</module>
|
|
|
|
<!-- Taille -->
|
|
<module name="AnonInnerLength">
|
|
<property name="max" value="30"/>
|
|
</module>
|
|
<module name="ExecutableStatementCount">
|
|
<property name="max" value="50"/>
|
|
</module>
|
|
<module name="LineLength">
|
|
<property name="max" value="120"/>
|
|
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
|
|
</module>
|
|
<module name="MethodCount">
|
|
<property name="maxTotal" value="50"/>
|
|
<property name="maxPrivate" value="30"/>
|
|
<property name="maxPackage" value="30"/>
|
|
<property name="maxProtected" value="30"/>
|
|
<property name="maxPublic" value="30"/>
|
|
</module>
|
|
<module name="MethodLength">
|
|
<property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
|
|
<property name="max" value="100"/>
|
|
</module>
|
|
<module name="OuterTypeNumber"/>
|
|
<module name="ParameterNumber">
|
|
<property name="max" value="8"/>
|
|
<property name="ignoreOverriddenMethods" value="true"/>
|
|
<property name="tokens" value="METHOD_DEF, CTOR_DEF"/>
|
|
</module>
|
|
|
|
<!-- Espaces blancs -->
|
|
<module name="EmptyForIteratorPad"/>
|
|
<module name="EmptyLineSeparator">
|
|
<property name="allowNoEmptyLineBetweenFields" value="true"/>
|
|
</module>
|
|
<module name="GenericWhitespace">
|
|
<message key="ws.followed" value="GenericWhitespace ''{0}'' is followed by whitespace."/>
|
|
<message key="ws.preceded" value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
|
|
<message key="ws.illegalFollow" value="GenericWhitespace ''{0}'' should followed by whitespace."/>
|
|
<message key="ws.notPreceded" value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
|
|
</module>
|
|
<module name="MethodParamPad"/>
|
|
<module name="NoLineWrap"/>
|
|
<module name="NoWhitespaceAfter"/>
|
|
<module name="NoWhitespaceBefore"/>
|
|
<module name="OperatorWrap">
|
|
<property name="option" value="NL"/>
|
|
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
|
|
</module>
|
|
<module name="ParenPad"/>
|
|
<module name="SeparatorWrap">
|
|
<property name="id" value="SeparatorWrapDot"/>
|
|
<property name="tokens" value="DOT"/>
|
|
<property name="option" value="nl"/>
|
|
</module>
|
|
<module name="SeparatorWrap">
|
|
<property name="id" value="SeparatorWrapComma"/>
|
|
<property name="tokens" value="COMMA"/>
|
|
<property name="option" value="EOL"/>
|
|
</module>
|
|
<module name="SeparatorWrap">
|
|
<property name="id" value="SeparatorWrapEllipsis"/>
|
|
<property name="tokens" value="ELLIPSIS"/>
|
|
<property name="option" value="EOL"/>
|
|
</module>
|
|
<module name="SeparatorWrap">
|
|
<property name="id" value="SeparatorWrapArrayDeclarator"/>
|
|
<property name="tokens" value="ARRAY_DECLARATOR"/>
|
|
<property name="option" value="EOL"/>
|
|
</module>
|
|
<module name="SeparatorWrap">
|
|
<property name="id" value="SeparatorWrapMethodRef"/>
|
|
<property name="tokens" value="METHOD_REF"/>
|
|
<property name="option" value="nl"/>
|
|
</module>
|
|
<module name="TypecastParenPad"/>
|
|
<module name="WhitespaceAfter"/>
|
|
<module name="WhitespaceAround">
|
|
<property name="allowEmptyConstructors" value="true"/>
|
|
<property name="allowEmptyMethods" value="true"/>
|
|
<property name="allowEmptyTypes" value="true"/>
|
|
<property name="allowEmptyLoops" value="true"/>
|
|
<message key="ws.notFollowed" value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
|
|
<message key="ws.notPreceded" value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
|
|
</module>
|
|
|
|
</module>
|
|
</module>
|