Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: third_party/checkstyle/java/rules/google_checks.xml

Issue 29347926: Issue 4248 - Add codestyle check
Patch Set: changed import order - `org.adblockplus` package first Created Dec. 2, 2016, 6:19 a.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 <?xml version="1.0"?>
2 <!DOCTYPE module PUBLIC
3 "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
4 "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
5
6 <!--
diegocarloslima 2017/04/07 13:46:38 Maybe would be good the put the link of where this
7 Checkstyle configuration that checks the Google coding conventions from Goog le Java Style
8 that can be found at https://google.github.io/styleguide/javaguide.html.
9
10 Checkstyle is very configurable. Be sure to read the documentation at
11 http://checkstyle.sf.net (or in your downloaded distribution).
12
13 To completely disable a check, just comment it out or delete it from the fil e.
14
15 Authors: Max Vetrenko, Ruslan Diachenko, Roman Ivanov.
16 -->
17
18 <module name = "Checker">
19 <property name="charset" value="UTF-8"/>
20
21 <property name="severity" value="warning"/>
22
23 <property name="fileExtensions" value="java, properties, xml"/>
24 <!-- Checks for whitespace -->
25 <!-- See http://checkstyle.sf.net/config_whitespace.html -->
26 <module name="FileTabCharacter">
27 <property name="eachLine" value="true"/>
28 </module>
29
30 <module name="TreeWalker">
31 <module name="OuterTypeFilename"/>
32 <module name="IllegalTokenText">
33 <property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
34 <property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|2 7|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
35 <property name="message" value="Avoid using corresponding octal or U nicode escape."/>
36 </module>
37 <module name="AvoidEscapedUnicodeCharacters">
38 <property name="allowEscapesForControlCharacters" value="true"/>
39 <property name="allowByTailComment" value="true"/>
40 <property name="allowNonPrintableEscapes" value="true"/>
41 </module>
42 <module name="LineLength">
43 <property name="max" value="100"/>
44 <property name="ignorePattern" value="^package.*|^import.*|a href|hr ef|http://|https://|ftp://"/>
45 </module>
46 <module name="AvoidStarImport"/>
47 <module name="OneTopLevelClass"/>
48 <module name="NoLineWrap"/>
49 <module name="EmptyBlock">
50 <property name="option" value="TEXT"/>
51 <property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL _IF, LITERAL_ELSE, LITERAL_SWITCH"/>
52 </module>
53 <module name="NeedBraces"/>
54 <module name="LeftCurly">
55 <property name="maxLineLength" value="100"/>
56 </module>
57 <module name="RightCurly"/>
58 <module name="RightCurly">
59 <property name="option" value="alone"/>
60 <property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITE RAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
61 </module>
62 <module name="WhitespaceAround">
63 <property name="allowEmptyConstructors" value="true"/>
64 <property name="allowEmptyMethods" value="true"/>
65 <property name="allowEmptyTypes" value="true"/>
66 <property name="allowEmptyLoops" value="true"/>
67 <message key="ws.notFollowed"
68 value="WhitespaceAround: ''{0}'' is not followed by whitespace. Emp ty blocks may only be represented as '{}' when not part of a multi-block stateme nt (4.1.3)"/>
69 <message key="ws.notPreceded"
70 value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/ >
71 </module>
72 <module name="OneStatementPerLine"/>
73 <module name="MultipleVariableDeclarations"/>
74 <module name="ArrayTypeStyle"/>
75 <module name="MissingSwitchDefault"/>
76 <module name="FallThrough"/>
77 <module name="UpperEll"/>
78 <module name="ModifierOrder"/>
79 <module name="EmptyLineSeparator">
80 <property name="allowNoEmptyLineBetweenFields" value="true"/>
81 </module>
82 <module name="SeparatorWrap">
83 <property name="tokens" value="DOT"/>
84 <property name="option" value="nl"/>
85 </module>
86 <module name="SeparatorWrap">
87 <property name="tokens" value="COMMA"/>
88 <property name="option" value="EOL"/>
89 </module>
90 <module name="PackageName">
91 <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
92 <message key="name.invalidPattern"
93 value="Package name ''{0}'' must match pattern ''{1}''."/>
94 </module>
95 <module name="TypeName">
96 <message key="name.invalidPattern"
97 value="Type name ''{0}'' must match pattern ''{1}''."/>
98 </module>
99 <module name="MemberName">
100 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
101 <message key="name.invalidPattern"
102 value="Member name ''{0}'' must match pattern ''{1}''."/>
103 </module>
104 <module name="ParameterName">
105 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
106 <message key="name.invalidPattern"
107 value="Parameter name ''{0}'' must match pattern ''{1}''."/>
108 </module>
109 <module name="CatchParameterName">
110 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
111 <message key="name.invalidPattern"
112 value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
113 </module>
114 <module name="LocalVariableName">
115 <property name="tokens" value="VARIABLE_DEF"/>
116 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
117 <property name="allowOneCharVarInForLoop" value="true"/>
118 <message key="name.invalidPattern"
119 value="Local variable name ''{0}'' must match pattern ''{1}''."/>
120 </module>
121 <module name="ClassTypeParameterName">
122 <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T] $)"/>
123 <message key="name.invalidPattern"
124 value="Class type name ''{0}'' must match pattern ''{1}''."/>
125 </module>
126 <module name="MethodTypeParameterName">
127 <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T] $)"/>
128 <message key="name.invalidPattern"
129 value="Method type name ''{0}'' must match pattern ''{1}''."/>
130 </module>
131 <module name="InterfaceTypeParameterName">
132 <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T] $)"/>
133 <message key="name.invalidPattern"
134 value="Interface type name ''{0}'' must match pattern ''{1}''."/>
135 </module>
136 <module name="NoFinalizer"/>
137 <module name="GenericWhitespace">
138 <message key="ws.followed"
139 value="GenericWhitespace ''{0}'' is followed by whitespace."/>
140 <message key="ws.preceded"
141 value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
142 <message key="ws.illegalFollow"
143 value="GenericWhitespace ''{0}'' should followed by whitespace."/>
144 <message key="ws.notPreceded"
145 value="GenericWhitespace ''{0}'' is not preceded with whitespace."/ >
146 </module>
147 <module name="Indentation">
148 <property name="basicOffset" value="2"/>
149 <property name="braceAdjustment" value="0"/>
150 <property name="caseIndent" value="2"/>
151 <property name="throwsIndent" value="4"/>
152 <property name="lineWrappingIndentation" value="4"/>
153 <property name="arrayInitIndent" value="2"/>
154 </module>
155 <module name="AbbreviationAsWordInName">
156 <property name="ignoreFinal" value="false"/>
157 <property name="allowedAbbreviationLength" value="1"/>
158 </module>
159 <module name="OverloadMethodsDeclarationOrder"/>
160 <module name="VariableDeclarationUsageDistance"/>
161 <module name="CustomImportOrder">
162 <property name="specialImportsRegExp" value="com.google"/>
163 <property name="sortImportsInGroupAlphabetically" value="true"/>
164 <property name="customImportOrderRules" value="STATIC###SPECIAL_IMPO RTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
165 </module>
166 <module name="MethodParamPad"/>
167 <module name="OperatorWrap">
168 <property name="option" value="NL"/>
169 <property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTIO N, SL, SR, STAR "/>
170 </module>
171 <module name="AnnotationLocation">
172 <property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, M ETHOD_DEF, CTOR_DEF"/>
173 </module>
174 <module name="AnnotationLocation">
175 <property name="tokens" value="VARIABLE_DEF"/>
176 <property name="allowSamelineMultipleAnnotations" value="true"/>
177 </module>
178 <module name="NonEmptyAtclauseDescription"/>
179 <module name="JavadocTagContinuationIndentation"/>
180 <module name="SummaryJavadoc">
181 <property name="forbiddenSummaryFragments" value="^@return the *|^Th is method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
182 </module>
183 <module name="JavadocParagraph"/>
184 <module name="AtclauseOrder">
185 <property name="tagOrder" value="@param, @return, @throws, @deprecat ed"/>
186 <property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, M ETHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
187 </module>
188 <module name="JavadocMethod">
189 <property name="scope" value="public"/>
190 <property name="allowMissingParamTags" value="true"/>
191 <property name="allowMissingThrowsTags" value="true"/>
192 <property name="allowMissingReturnTag" value="true"/>
193 <property name="minLineCount" value="2"/>
194 <property name="allowedAnnotations" value="Override, Test"/>
195 <property name="allowThrowsTagsForSubclasses" value="true"/>
196 </module>
197 <module name="MethodName">
198 <property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
199 <message key="name.invalidPattern"
200 value="Method name ''{0}'' must match pattern ''{1}''."/>
201 </module>
202 <module name="SingleLineJavadoc">
203 <property name="ignoreInlineTags" value="false"/>
204 </module>
205 <module name="EmptyCatchBlock">
206 <property name="exceptionVariableName" value="expected"/>
207 </module>
208 <module name="CommentsIndentation"/>
209 </module>
210 </module>
OLDNEW

Powered by Google App Engine
This is Rietveld