Skip to content

A
AloqaIM-Android
Commit 73f38004 authored by Yusuke Iwaki's avatar Yusuke Iwaki
Browse files
Options

replace checkstyle rule with... 

replace checkstyle rule with https://android.googlesource.com/platform/development/+/master/tools/checkstyle/android-style.xml
parent d6e44491
Hide whitespace changes
Inline Side-by-side
Showing with 246 additions and 218 deletions
config/quality/checkstyle/checkstyle-config.xml
View file @ 73f38004
<?xml version="1.0"?><!DOCTYPE module PUBLIC <?xml version="1.0" encoding="UTF-8"?>
"-//Puppy Crawl//DTD Check Configuration 1.3//EN" <!DOCTYPE module PUBLIC "-//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"> <module name="Checker">
<property name="severity" value="warning"/>
<!-- <property name="charset" value="UTF-8"/>
Checkstyle configuration that checks the Google coding conventions from Google Java Style <module name="SuppressionCommentFilter">
that can be found at https://google.github.io/styleguide/javaguide.html. <property name="offCommentFormat" value="CHECKSTYLE:OFF IndentationCheck"/>
<property name="onCommentFormat" value="CHECKSTYLE:ON IndentationCheck"/>
Checkstyle is very configurable. Be sure to read the documentation at <property name="checkFormat" value="IndentationCheck"/>
http://checkstyle.sf.net (or in your downloaded distribution). </module>
<module name="SuppressionCommentFilter">
To completely disable a check, just comment it out or delete it from the file. <property name="offCommentFormat" value="CHECKSTYLE:OFF Generated code"/>
<property name="onCommentFormat" value="CHECKSTYLE:ON Generated code"/>
Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov. </module>
--> <module name="TreeWalker">
<module name="AvoidStarImport">
<module name="Checker"> <property name="severity" value="error"/>
<property name="charset" value="UTF-8" /> <property name="excludes" value="org.junit.Assert,org.mockito.Mockito,org.hamcrest.Matchers"/>
</module>
<property name="severity" value="error" /> <module name="IllegalCatch">
<property name="severity" value="info"/>
<property name="fileExtensions" value="java, properties, xml" /> </module>
<!-- Checks for whitespace --> <module name="RedundantImport">
<!-- See http://checkstyle.sf.net/config_whitespace.html --> <message key="import.redundant" value="Redundant import: {0}. Use Ctrl+Shift+O (Eclipse) or Ctrl+Alt+O (Intellij) to sort imports"/>
<module name="FileTabCharacter"> <property name="severity" value="error"/>
<property name="eachLine" value="true" /> </module>
</module> <module name="UnusedImports">
<message key="import.unused" value="Unused import: {0}. Use Ctrl+Shift+O (Eclipse) or Ctrl+Alt+O (Intellij) to sort imports"/>
<module name="TreeWalker"> <property name="severity" value="error"/>
<module name="OuterTypeFilename" /> <property name="processJavadoc" value="true"/>
<module name="IllegalTokenText"> </module>
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL" /> <module name="JavadocType">
<property name="format" <property name="severity" value="warning"/>
value="\\u00(08|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="tokens" value="INTERFACE_DEF, CLASS_DEF"/>
<property name="message" value="Avoid using corresponding octal or Unicode escape." /> <property name="scope" value="public"/>
</module> <property name="allowUnknownTags" value="true"/> <!-- Allows @hide tags in JavaDocs -->
<module name="AvoidEscapedUnicodeCharacters"> <message key="javadoc.missing" value="Public classes and interfaces require JavaDoc comments."/>
<property name="allowEscapesForControlCharacters" value="true" /> </module>
<property name="allowByTailComment" value="true" /> <module name="JavadocMethod">
<property name="allowNonPrintableEscapes" value="true" /> <property name="severity" value="error"/>
</module> <property name="scope" value="public"/>
<module name="LineLength"> <property name="tokens" value="METHOD_DEF"/>
<property name="max" value="100" /> <property name="allowMissingParamTags" value="true"/>
<property name="ignorePattern" <property name="allowMissingPropertyJavadoc" value="true"/>
value="^package.*|^import.*|a href|href|http://|https://|ftp://" /> <property name="allowMissingReturnTag" value="true"/>
</module> <property name="allowMissingThrowsTags" value="true"/>
<module name="AvoidStarImport" /> </module>
<module name="OneTopLevelClass" /> <module name="PackageName">
<module name="NoLineWrap" /> <property name="severity" value="error"/>
<module name="EmptyBlock"> <property name="format" value="^[a-z]+(\.[a-z][a-z0-9_]{1,})*$"/>
<property name="option" value="TEXT" /> </module>
<property name="tokens" <module name="SimplifyBooleanExpression">
value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH" /> <property name="severity" value="error"/>
</module> </module>
<module name="NeedBraces" /> <module name="SimplifyBooleanReturn">
<module name="LeftCurly"> <property name="severity" value="error"/>
<property name="maxLineLength" value="100" /> </module>
</module> <module name="TypeName">
<module name="RightCurly" /> <property name="severity" value="error"/>
<module name="RightCurly"> </module>
<property name="option" value="alone" /> <module name="ConstantName">
<property name="tokens" <property name="severity" value="error"/>
value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT" /> <property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*)|(s[A-Z][a-zA-Z0-9]*)$"/>
</module> <message key="name.invalidPattern" value="Static final field names must either be all caps (e.g. int HEIGHT_PX) for 'true' constants, or start with s (e.g. AtomicInteger sNextId or Runnable sSuspendTask) for fields with mutable state or that don't 'feel' like constants."/>
<module name="WhitespaceAround"> </module>
<property name="allowEmptyConstructors" value="true" /> <!-- Non-public, non-static field names start with m. -->
<property name="allowEmptyMethods" value="true" /> <module name="MemberName">
<property name="allowEmptyTypes" value="true" /> <property name="severity" value="error"/>
<property name="allowEmptyLoops" value="true" /> <property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
<message key="ws.notFollowed" <property name="applyToPublic" value="false"/>
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="name.invalidPattern" value="Non-public, non-static field names start with m."/>
<message key="ws.notPreceded" </module>
value="WhitespaceAround: ''{0}'' is not preceded with whitespace." /> <!-- Static field names start with s. -->
</module> <module name="StaticVariableName">
<module name="OneStatementPerLine" /> <property name="severity" value="error"/>
<module name="MultipleVariableDeclarations" /> <property name="format" value="^s[A-Z][a-zA-Z0-9]*$"/>
<module name="ArrayTypeStyle" /> <property name="applyToPublic" value="false"/>
<module name="MissingSwitchDefault" /> <message key="name.invalidPattern" value="Static field names start with s."/>
<module name="FallThrough" /> </module>
<module name="UpperEll" /> <module name="MethodName">
<module name="ModifierOrder" /> <property name="severity" value="error"/>
<module name="EmptyLineSeparator"> <property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
<property name="allowNoEmptyLineBetweenFields" value="true" /> <message key="name.invalidPattern" value="Method names should start with a lower case letter (e.g. getWidth())"/>
</module> </module>
<module name="SeparatorWrap"> <module name="ParameterName">
<property name="tokens" value="DOT" /> <property name="severity" value="error"/>
<property name="option" value="nl" /> </module>
</module> <module name="LocalFinalVariableName">
<module name="SeparatorWrap"> <property name="severity" value="error"/>
<property name="tokens" value="COMMA" /> <property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
<property name="option" value="EOL" /> <message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
</module> </module>
<module name="PackageName"> <module name="LocalVariableName">
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$" /> <property name="severity" value="error"/>
<message key="name.invalidPattern" <property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
value="Package name ''{0}'' must match pattern ''{1}''." /> <message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
</module> </module>
<module name="TypeName"> <module name="LineLength">
<message key="name.invalidPattern" <property name="severity" value="error"/>
value="Type name ''{0}'' must match pattern ''{1}''." /> <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
</module> <property name="max" value="100"/>
<module name="MemberName"> </module>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$" /> <module name="LeftCurly">
<message key="name.invalidPattern" <property name="severity" value="error"/>
value="Member name ''{0}'' must match pattern ''{1}''." /> </module>
</module> <module name="RightCurly">
<module name="ParameterName"> <property name="severity" value="error"/>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$" /> </module>
<message key="name.invalidPattern" <module name="NeedBraces">
value="Parameter name ''{0}'' must match pattern ''{1}''." /> <message key="needBraces" value="if, for, while, and do require curly braces unless they are single-line statements."/>
</module> <property name="severity" value="error"/>
<module name="CatchParameterName"> <property name="tokens" value="LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, LITERAL_IF"/>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$" /> <property name="allowSingleLineStatement" value="true"/>
<message key="name.invalidPattern" </module>
value="Catch parameter name ''{0}'' must match pattern ''{1}''." /> <module name="EmptyBlock">
</module> <property name="severity" value="error"/>
<module name="LocalVariableName"> <property name="option" value="text"/>
<property name="tokens" value="VARIABLE_DEF" /> <metadata name="altname" value="EmptyCatchBlock"/>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$" /> </module>
<property name="allowOneCharVarInForLoop" value="true" /> <module name="UpperEll">
<message key="name.invalidPattern" <property name="severity" value="error"/>
value="Local variable name ''{0}'' must match pattern ''{1}''." /> </module>
</module> <module name="FallThrough">
<module name="ClassTypeParameterName"> <property name="severity" value="error"/>
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" /> <property name="reliefPattern" value=".*"/>
<message key="name.invalidPattern" </module>
value="Class type name ''{0}'' must match pattern ''{1}''." /> <module name="ModifierOrder">
</module> <property name="severity" value="error"/>
<module name="MethodTypeParameterName"> </module>
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" /> <module name="WhitespaceAround">
<message key="name.invalidPattern" <property name="severity" value="error"/>
value="Method type name ''{0}'' must match pattern ''{1}''." /> <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, EQUAL, GE, GT, LAND, LE, LITERAL_ASSERT, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, TYPE_EXTENSION_AND" />
</module> <property name="allowEmptyConstructors" value="true"/>
<module name="InterfaceTypeParameterName"> <property name="allowEmptyMethods" value="true"/>
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)" /> </module>
<message key="name.invalidPattern" <module name="WhitespaceAfter">
value="Interface type name ''{0}'' must match pattern ''{1}''." /> <property name="severity" value="error"/>
</module> <property name="tokens" value="COMMA, SEMI, TYPECAST"/>
<module name="NoFinalizer" /> </module>
<module name="GenericWhitespace"> <module name="NoWhitespaceAfter">
<message key="ws.followed" <property name="severity" value="error"/>
value="GenericWhitespace ''{0}'' is followed by whitespace." /> <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
<message key="ws.preceded" </module>
value="GenericWhitespace ''{0}'' is preceded with whitespace." /> <module name="NoWhitespaceBefore">
<message key="ws.illegalFollow" <property name="severity" value="error"/>
value="GenericWhitespace ''{0}'' should followed by whitespace." /> <property name="allowLineBreaks" value="true"/>
<message key="ws.notPreceded" <property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
value="GenericWhitespace ''{0}'' is not preceded with whitespace." /> </module>
</module> <module name="GenericWhitespace">
<module name="Indentation"> <property name="severity" value="error"/>
<property name="basicOffset" value="2" /> <message key="ws.followed"
<property name="braceAdjustment" value="0" /> value="GenericWhitespace ''{0}'' is followed by whitespace."/>
<property name="caseIndent" value="2" /> <message key="ws.preceded"
<property name="throwsIndent" value="4" /> value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
<property name="lineWrappingIndentation" value="4" /> <message key="ws.illegalFollow"
<property name="arrayInitIndent" value="2" /> value="GenericWhitespace ''{0}'' should followed by whitespace."/>
</module> <message key="ws.notPreceded"
<module name="AbbreviationAsWordInName"> value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
<property name="ignoreFinal" value="false" /> </module>
<property name="allowedAbbreviationLength" value="1" /> <module name="EmptyStatement">
</module> <property name="severity" value="error"/>
<module name="OverloadMethodsDeclarationOrder" /> </module>
<module name="VariableDeclarationUsageDistance" /> <module name="NoFinalizer">
<module name="CustomImportOrder"> <property name="severity" value="info"/>
<property name="specialImportsRegExp" value="com.google" /> </module>
<property name="sortImportsInGroupAlphabetically" value="true" /> <module name="ParenPad">
<property name="customImportOrderRules" <property name="severity" value="error"/>
value="STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE" /> </module>
</module> <module name="MethodParamPad">
<module name="MethodParamPad" /> <property name="severity" value="error"/>
<module name="OperatorWrap"> </module>
<property name="option" value="NL" /> <module name="ImportOrder">
<property name="tokens" <property name="severity" value="error"/>
value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR " /> <message key="import.ordering" value="Wrong order for {0} import. Use Ctrl+Shift+O (Eclipse) or Ctrl+Alt+O (Intellij) to sort imports"/>
</module> <property name="groups" value="android, com.android, dalvik, com, gov, junit, libcore, net, org, java, javax"/>
<module name="AnnotationLocation"> <property name="ordered" value="true"/>
<property name="tokens" <property name="option" value="top"/>
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF" /> <property name="separated" value="true"/>
</module> </module>
<module name="AnnotationLocation"> <module name="Indentation">
<property name="tokens" value="VARIABLE_DEF" /> <property name="severity" value="error"/>
<property name="allowSamelineMultipleAnnotations" value="true" /> <property name="basicOffset" value="4"/>
</module> <property name="throwsIndent" value="8"/>
<module name="NonEmptyAtclauseDescription" /> <property name="lineWrappingIndentation" value="8"/>
<module name="JavadocTagContinuationIndentation" /> </module>
<module name="SummaryJavadoc"> <module name="OperatorWrap">
<property name="forbiddenSummaryFragments" <property name="severity" value="error"/>
value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )" /> <property name="option" value="NL" />
</module> <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 " />
<module name="JavadocParagraph" /> </module>
<module name="AtclauseOrder"> <module name="OperatorWrap">
<property name="tagOrder" value="@param, @return, @throws, @deprecated" /> <property name="severity" value="error"/>
<property name="target" <property name="option" value="eol"/>
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF" /> <property name="tokens" value="ASSIGN"/>
</module> </module>
<module name="JavadocMethod"> <module name="SeparatorWrap">
<property name="scope" value="public" /> <property name="severity" value="error"/>
<property name="allowMissingParamTags" value="true" /> <property name="tokens" value="DOT"/>
<property name="allowMissingThrowsTags" value="true" /> <property name="option" value="nl"/>
<property name="allowMissingReturnTag" value="true" /> </module>
<property name="minLineCount" value="2" /> <module name="SeparatorWrap">
<property name="allowedAnnotations" value="Override, Test" /> <property name="severity" value="error"/>
<property name="allowThrowsTagsForSubclasses" value="true" /> <property name="tokens" value="COMMA"/>
</module> <property name="option" value="EOL"/>
<module name="MethodName"> </module>
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$" /> <module name="MissingDeprecated">
<message key="name.invalidPattern" <property name="severity" value="error"/>
value="Method name ''{0}'' must match pattern ''{1}''." /> </module>
</module> <module name="MissingOverride">
<module name="SingleLineJavadoc"> <property name="severity" value="error"/>
<property name="ignoreInlineTags" value="false" /> </module>
</module> <module name="OneTopLevelClass">
<module name="EmptyCatchBlock"> <property name="severity" value="error"/>
<property name="exceptionVariableName" value="expected" /> </module>
</module> <module name="StringLiteralEquality">
<module name="CommentsIndentation" /> <property name="severity" value="error"/>
</module> </module>
</module> <module name="ArrayTypeStyle">
<property name="severity" value="error"/>
</module>
<module name="RedundantModifier">
<property name="severity" value="error"/>
</module>
<module name="OuterTypeFilename">
<property name="severity" value="error"/>
</module>
<module name="FileContentsHolder"/>
</module>
<module name="FileTabCharacter">
<property name="severity" value="error"/>
</module>
<module name="NewlineAtEndOfFile">
<property name="severity" value="error"/>
</module>
<module name="RegexpSingleline">
<property name="severity" value="error"/>
<property name="format" value="[ \t]+$"/>
<property name="message" value="Trailing whitespace"/>
</module>
<module name="RegexpHeader">
<property name="severity" value="error"/>
<message key="header.mismatch"
value="Android Copyright header seems to be incorrect. Expected ''{0}'' on this line."/>
<property name="header" value="^/\*\n \* Copyright \([Cc]\) [0-9]{4} The Android Open Source Project\n \*\n \* Licensed under the Apache License, Version 2\.0 \(the \&quot;License\&quot;\);\n \* you may not use this file except in compliance with the License.\n \* You may obtain a copy of the License at\n \*\n \* http:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0\n \*\n \* Unless required by applicable law or agreed to in writing, software\n \* distributed under the License is distributed on an &quot;AS IS&quot; BASIS,\n \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.\n \* See the License for the specific language governing permissions and\n \* limitations under the License\.\n \*\/" />
</module>
</module>
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Technounit-GROUP 2023