Skip to content

Commit 36824c9

Browse files
liutikasliutikas
committed
Split android-style.xml into modules for checkstyle.
This will allow teams to reuse parts of checkstyle without having to worry about missing any checks when they change in the main configs. Bug: None Test: Tested locally and checkstyle still verifies the same rules using android-style.xml Change-Id: I91ca11d3d7089db656bc640549bd7012284a8859
1 parent 57c81cf commit 36824c9

File tree

5 files changed

+329
-241
lines changed

5 files changed

+329
-241
lines changed

‎tools/checkstyle/android-style.xml‎

Lines changed: 25 additions & 241 deletions
Original file line numberDiff line numberDiff line change
@@ -1,247 +1,31 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
2+
<!--
3+
~ Copyright (C) 2016 The Android Open Source Project
4+
~
5+
~ Licensed under the Apache License, Version 2.0 (the "License");
6+
~ you may not use this file except in compliance with the License.
7+
~ You may obtain a copy of the License at
8+
~
9+
~ http://www.apache.org/licenses/LICENSE-2.0
10+
~
11+
~ Unless required by applicable law or agreed to in writing, software
12+
~ distributed under the License is distributed on an "AS IS" BASIS,
13+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
~ See the License for the specific language governing permissions and
15+
~ limitations under the License.
16+
-->
17+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd" [
18+
<!ENTITY defaultCopyrightCheck SYSTEM "default-copyright-check.xml">
19+
<!ENTITY defaultJavadocChecks SYSTEM "default-javadoc-checks.xml">
20+
<!ENTITY defaultTreewalkerChecks SYSTEM "default-treewalker-checks.xml">
21+
<!ENTITY defaultModuleChecks SYSTEM "default-module-checks.xml">
22+
]>
323

424
<module name="Checker">
5-
<property name="severity" value="warning"/>
6-
<property name="charset" value="UTF-8"/>
7-
<module name="SuppressionCommentFilter">
8-
<property name="offCommentFormat" value="CHECKSTYLE:OFF IndentationCheck"/>
9-
<property name="onCommentFormat" value="CHECKSTYLE:ON IndentationCheck"/>
10-
<property name="checkFormat" value="IndentationCheck"/>
11-
</module>
12-
<module name="SuppressionCommentFilter">
13-
<property name="offCommentFormat" value="CHECKSTYLE:OFF Generated code"/>
14-
<property name="onCommentFormat" value="CHECKSTYLE:ON Generated code"/>
15-
</module>
25+
&defaultModuleChecks;
26+
&defaultCopyrightCheck;
1627
<module name="TreeWalker">
17-
<module name="AvoidStarImport">
18-
<property name="severity" value="error"/>
19-
<property name="excludes" value="org.junit.Assert,org.mockito.Mockito,org.hamcrest.Matchers"/>
20-
</module>
21-
<module name="IllegalCatch">
22-
<property name="severity" value="info"/>
23-
</module>
24-
<module name="RedundantImport">
25-
<message key="import.redundant" value="Redundant import: {0}. Use Ctrl+Shift+O (Eclipse) or Ctrl+Alt+O (Intellij) to sort imports"/>
26-
<property name="severity" value="error"/>
27-
</module>
28-
<module name="UnusedImports">
29-
<message key="import.unused" value="Unused import: {0}. Use Ctrl+Shift+O (Eclipse) or Ctrl+Alt+O (Intellij) to sort imports"/>
30-
<property name="severity" value="error"/>
31-
<property name="processJavadoc" value="true"/>
32-
</module>
33-
<module name="JavadocType">
34-
<property name="severity" value="warning"/>
35-
<property name="tokens" value="INTERFACE_DEF, CLASS_DEF"/>
36-
<property name="scope" value="public"/>
37-
<property name="allowUnknownTags" value="true"/> <!-- Allows @hide tags in JavaDocs -->
38-
<message key="javadoc.missing" value="Public classes and interfaces require JavaDoc comments."/>
39-
</module>
40-
<module name="JavadocMethod">
41-
<property name="severity" value="error"/>
42-
<property name="scope" value="public"/>
43-
<property name="tokens" value="METHOD_DEF"/>
44-
<property name="allowMissingParamTags" value="true"/>
45-
<property name="allowMissingPropertyJavadoc" value="true"/>
46-
<property name="allowMissingReturnTag" value="true"/>
47-
<property name="allowMissingThrowsTags" value="true"/>
48-
</module>
49-
<module name="PackageName">
50-
<property name="severity" value="error"/>
51-
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9_]{1,})*$"/>
52-
</module>
53-
<module name="SimplifyBooleanExpression">
54-
<property name="severity" value="error"/>
55-
</module>
56-
<module name="SimplifyBooleanReturn">
57-
<property name="severity" value="error"/>
58-
</module>
59-
<module name="TypeName">
60-
<property name="severity" value="error"/>
61-
</module>
62-
<module name="ConstantName">
63-
<property name="severity" value="error"/>
64-
<property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*)|(s[A-Z][a-zA-Z0-9]*)$"/>
65-
<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."/>
66-
</module>
67-
<!-- Non-public, non-static field names start with m. -->
68-
<module name="MemberName">
69-
<property name="severity" value="error"/>
70-
<property name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
71-
<property name="applyToPublic" value="false"/>
72-
<message key="name.invalidPattern" value="Non-public, non-static field names start with m."/>
73-
</module>
74-
<!-- Static field names start with s. -->
75-
<module name="StaticVariableName">
76-
<property name="severity" value="error"/>
77-
<property name="format" value="^s[A-Z][a-zA-Z0-9]*$"/>
78-
<property name="applyToPublic" value="false"/>
79-
<message key="name.invalidPattern" value="Static field names start with s."/>
80-
</module>
81-
<module name="MethodName">
82-
<property name="severity" value="error"/>
83-
<property name="format" value="^[a-z][a-zA-Z0-9_]*$"/>
84-
<message key="name.invalidPattern" value="Method names should start with a lower case letter (e.g. getWidth())"/>
85-
</module>
86-
<module name="ParameterName">
87-
<property name="severity" value="error"/>
88-
</module>
89-
<module name="LocalFinalVariableName">
90-
<property name="severity" value="error"/>
91-
<property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
92-
<message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
93-
</module>
94-
<module name="LocalVariableName">
95-
<property name="severity" value="error"/>
96-
<property name="format" value="^m|s|((([ms][a-z0-9])|([a-ln-rt-z]))[a-zA-Z0-9]*)$"/>
97-
<message key="name.invalidPattern" value="Local variables should be camel-cased (e.g. int minWidth = 4)."/>
98-
</module>
99-
<module name="LineLength">
100-
<property name="severity" value="error"/>
101-
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
102-
<property name="max" value="100"/>
103-
</module>
104-
<module name="LeftCurly">
105-
<property name="severity" value="error"/>
106-
</module>
107-
<module name="RightCurly">
108-
<property name="severity" value="error"/>
109-
</module>
110-
<module name="NeedBraces">
111-
<message key="needBraces" value="if, for, while, and do require curly braces unless they are single-line statements."/>
112-
<property name="severity" value="error"/>
113-
<property name="tokens" value="LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, LITERAL_IF"/>
114-
<property name="allowSingleLineStatement" value="true"/>
115-
</module>
116-
<module name="EmptyBlock">
117-
<property name="severity" value="error"/>
118-
<property name="option" value="text"/>
119-
<metadata name="altname" value="EmptyCatchBlock"/>
120-
</module>
121-
<module name="UpperEll">
122-
<property name="severity" value="error"/>
123-
</module>
124-
<module name="FallThrough">
125-
<property name="severity" value="error"/>
126-
<property name="reliefPattern" value=".*"/>
127-
</module>
128-
<module name="ModifierOrder">
129-
<property name="severity" value="error"/>
130-
</module>
131-
<module name="WhitespaceAround">
132-
<property name="severity" value="error"/>
133-
<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" />
134-
<property name="allowEmptyConstructors" value="true"/>
135-
<property name="allowEmptyMethods" value="true"/>
136-
</module>
137-
<module name="WhitespaceAfter">
138-
<property name="severity" value="error"/>
139-
<property name="tokens" value="COMMA, SEMI, TYPECAST"/>
140-
</module>
141-
<module name="NoWhitespaceAfter">
142-
<property name="severity" value="error"/>
143-
<property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
144-
</module>
145-
<module name="NoWhitespaceBefore">
146-
<property name="severity" value="error"/>
147-
<property name="allowLineBreaks" value="true"/>
148-
<property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
149-
</module>
150-
<module name="GenericWhitespace">
151-
<property name="severity" value="error"/>
152-
<message key="ws.followed"
153-
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
154-
<message key="ws.preceded"
155-
value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
156-
<message key="ws.illegalFollow"
157-
value="GenericWhitespace ''{0}'' should followed by whitespace."/>
158-
<message key="ws.notPreceded"
159-
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
160-
</module>
161-
<module name="EmptyStatement">
162-
<property name="severity" value="error"/>
163-
</module>
164-
<module name="NoFinalizer">
165-
<property name="severity" value="info"/>
166-
</module>
167-
<module name="ParenPad">
168-
<property name="severity" value="error"/>
169-
</module>
170-
<module name="MethodParamPad">
171-
<property name="severity" value="error"/>
172-
</module>
173-
<module name="ImportOrder">
174-
<property name="severity" value="error"/>
175-
<message key="import.ordering" value="Wrong order for {0} import. Use Ctrl+Shift+O (Eclipse) or Ctrl+Alt+O (Intellij) to sort imports"/>
176-
<property name="groups" value="android, com.android, dalvik, com, gov, junit, libcore, net, org, java, javax"/>
177-
<property name="ordered" value="true"/>
178-
<property name="option" value="top"/>
179-
<property name="separated" value="true"/>
180-
</module>
181-
<module name="Indentation">
182-
<property name="severity" value="error"/>
183-
<property name="basicOffset" value="4"/>
184-
<property name="throwsIndent" value="8"/>
185-
<property name="lineWrappingIndentation" value="8"/>
186-
</module>
187-
<module name="OperatorWrap">
188-
<property name="severity" value="error"/>
189-
<property name="option" value="NL" />
190-
<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 " />
191-
</module>
192-
<module name="OperatorWrap">
193-
<property name="severity" value="error"/>
194-
<property name="option" value="eol"/>
195-
<property name="tokens" value="ASSIGN"/>
196-
</module>
197-
<module name="SeparatorWrap">
198-
<property name="severity" value="error"/>
199-
<property name="tokens" value="DOT"/>
200-
<property name="option" value="nl"/>
201-
</module>
202-
<module name="SeparatorWrap">
203-
<property name="severity" value="error"/>
204-
<property name="tokens" value="COMMA"/>
205-
<property name="option" value="EOL"/>
206-
</module>
207-
<module name="MissingDeprecated">
208-
<property name="severity" value="error"/>
209-
</module>
210-
<module name="MissingOverride">
211-
<property name="severity" value="error"/>
212-
</module>
213-
<module name="OneTopLevelClass">
214-
<property name="severity" value="error"/>
215-
</module>
216-
<module name="StringLiteralEquality">
217-
<property name="severity" value="error"/>
218-
</module>
219-
<module name="ArrayTypeStyle">
220-
<property name="severity" value="error"/>
221-
</module>
222-
<module name="RedundantModifier">
223-
<property name="severity" value="error"/>
224-
</module>
225-
<module name="OuterTypeFilename">
226-
<property name="severity" value="error"/>
227-
</module>
228-
<module name="FileContentsHolder"/>
229-
</module>
230-
<module name="FileTabCharacter">
231-
<property name="severity" value="error"/>
232-
</module>
233-
<module name="NewlineAtEndOfFile">
234-
<property name="severity" value="error"/>
235-
</module>
236-
<module name="RegexpSingleline">
237-
<property name="severity" value="error"/>
238-
<property name="format" value="[ \t]+$"/>
239-
<property name="message" value="Trailing whitespace"/>
240-
</module>
241-
<module name="RegexpHeader">
242-
<property name="severity" value="error"/>
243-
<message key="header.mismatch"
244-
value="Android Copyright header seems to be incorrect. Expected ''{0}'' on this line."/>
245-
<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 \*\/" />
28+
&defaultJavadocChecks;
29+
&defaultTreewalkerChecks;
24630
</module>
24731
</module>

‎tools/checkstyle/default-copyright-check.xml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Copyright (C) 2016 The Android Open Source Project
4+
~
5+
~ Licensed under the Apache License, Version 2.0 (the "License");
6+
~ you may not use this file except in compliance with the License.
7+
~ You may obtain a copy of the License at
8+
~
9+
~ http://www.apache.org/licenses/LICENSE-2.0
10+
~
11+
~ Unless required by applicable law or agreed to in writing, software
12+
~ distributed under the License is distributed on an "AS IS" BASIS,
13+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
~ See the License for the specific language governing permissions and
15+
~ limitations under the License.
16+
-->
17+
<module name="RegexpHeader">
18+
<property name="severity" value="error"/>
19+
<message key="header.mismatch"
20+
value="Android Copyright header seems to be incorrect. Expected ''{0}'' on this line."/>
21+
<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 \*\/" />
22+
</module>

‎tools/checkstyle/default-javadoc-checks.xml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Copyright (C) 2016 The Android Open Source Project
4+
~
5+
~ Licensed under the Apache License, Version 2.0 (the "License");
6+
~ you may not use this file except in compliance with the License.
7+
~ You may obtain a copy of the License at
8+
~
9+
~ http://www.apache.org/licenses/LICENSE-2.0
10+
~
11+
~ Unless required by applicable law or agreed to in writing, software
12+
~ distributed under the License is distributed on an "AS IS" BASIS,
13+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
~ See the License for the specific language governing permissions and
15+
~ limitations under the License.
16+
-->
17+
<module name="JavadocType">
18+
<property name="severity" value="warning"/>
19+
<property name="tokens" value="INTERFACE_DEF, CLASS_DEF"/>
20+
<property name="scope" value="public"/>
21+
<property name="allowUnknownTags" value="true"/> <!-- Allows @hide tags in JavaDocs -->
22+
<message key="javadoc.missing" value="Public classes and interfaces require JavaDoc comments."/>
23+
</module>
24+
<module name="JavadocMethod">
25+
<property name="severity" value="error"/>
26+
<property name="scope" value="public"/>
27+
<property name="tokens" value="METHOD_DEF"/>
28+
<property name="allowMissingParamTags" value="true"/>
29+
<property name="allowMissingPropertyJavadoc" value="true"/>
30+
<property name="allowMissingReturnTag" value="true"/>
31+
<property name="allowMissingThrowsTags" value="true"/>
32+
</module>

‎tools/checkstyle/default-module-checks.xml‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!--
3+
~ Copyright (C) 2016 The Android Open Source Project
4+
~
5+
~ Licensed under the Apache License, Version 2.0 (the "License");
6+
~ you may not use this file except in compliance with the License.
7+
~ You may obtain a copy of the License at
8+
~
9+
~ http://www.apache.org/licenses/LICENSE-2.0
10+
~
11+
~ Unless required by applicable law or agreed to in writing, software
12+
~ distributed under the License is distributed on an "AS IS" BASIS,
13+
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
~ See the License for the specific language governing permissions and
15+
~ limitations under the License.
16+
-->
17+
<property name="severity" value="warning"/>
18+
<property name="charset" value="UTF-8"/>
19+
<module name="SuppressionCommentFilter">
20+
<property name="offCommentFormat" value="CHECKSTYLE:OFF IndentationCheck"/>
21+
<property name="onCommentFormat" value="CHECKSTYLE:ON IndentationCheck"/>
22+
<property name="checkFormat" value="IndentationCheck"/>
23+
</module>
24+
<module name="SuppressionCommentFilter">
25+
<property name="offCommentFormat" value="CHECKSTYLE:OFF Generated code"/>
26+
<property name="onCommentFormat" value="CHECKSTYLE:ON Generated code"/>
27+
</module>
28+
<module name="FileTabCharacter">
29+
<property name="severity" value="error"/>
30+
</module>
31+
<module name="NewlineAtEndOfFile">
32+
<property name="severity" value="error"/>
33+
</module>
34+
<module name="RegexpSingleline">
35+
<property name="severity" value="error"/>
36+
<property name="format" value="[ \t]+$"/>
37+
<property name="message" value="Trailing whitespace"/>
38+
</module>

0 commit comments

Comments
 (0)