|
1 | | -<?xml version="1.0" ?><!-- |
2 | | - ~ Copyright 2016 Patrick Favre-Bulle |
3 | | - ~ |
4 | | - ~ Licensed under the Apache License, Version 2.0 (the "License"); |
5 | | - ~ you may not use this file except in compliance with the License. |
6 | | - ~ You may obtain a copy of the License at |
7 | | - ~ |
8 | | - ~ http://www.apache.org/licenses/LICENSE-2.0 |
9 | | - ~ |
10 | | - ~ Unless required by applicable law or agreed to in writing, software |
11 | | - ~ distributed under the License is distributed on an "AS IS" BASIS, |
12 | | - ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
13 | | - ~ See the License for the specific language governing permissions and |
14 | | - ~ limitations under the License. |
15 | | - --> |
16 | | - |
17 | | -<!DOCTYPE module PUBLIC |
| 1 | +<?xml version="1.0" ?><!DOCTYPE module PUBLIC |
18 | 2 | "-//Puppy Crawl//DTD Check Configuration 1.2//EN" |
19 | 3 | "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> |
20 | 4 |
|
21 | | -<!--This it the config for the main source code with more strict rules than e.g. testing --> |
22 | | - |
23 | 5 | <module name="Checker"> |
24 | 6 | <module name="NewlineAtEndOfFile" /> <!-- force newline, important for git merge and POSIX compatibility: http://checkstyle.sourceforge.net/config_misc.html#NewlineAtEndOfFile --> |
25 | 7 | <module name="FileTabCharacter" /> <!-- e.g. disallow tab character outside of strings --> |
|
30 | 12 | <module name="FileLength"><!-- max line length for single file: http://checkstyle.sourceforge.net/config_sizes.html#FileLength --> |
31 | 13 | <property name="max" value="1500" /> |
32 | 14 | </module> |
| 15 | + <module name="LineLength"><!-- max char length per line http://checkstyle.sourceforge.net/config_sizes.html#LineLength --> |
| 16 | + <property name="max" value="300" /> |
| 17 | + </module> |
33 | 18 |
|
34 | 19 | <module name="TreeWalker"> |
35 | 20 | <module name="SuppressionCommentFilter" /> <!-- use //CHECKSTYLE:OFF (...) //CHECKSTYLE:ON to disable checkstyle: http://checkstyle.sourceforge.net/config_filters.html#SuppressionCommentFilter --> |
36 | 21 |
|
37 | 22 | <!-- Annotations --> |
38 | 23 | <module name="MissingDeprecated"> <!-- if @deprecated and javadoc is there, must be explained in javadoc: http://checkstyle.sourceforge.net/config_annotation.html#MissingDeprecated --> |
39 | | - <property name="skipNoJavadoc" value="true" /> |
40 | 24 | </module> |
41 | 25 | <module name="MissingOverride" /> <!-- if has @inheritDoc in javadoc must have @Override http://checkstyle.sourceforge.net/config_annotation.html#MissingOverride --> |
42 | 26 | <module name="PackageAnnotation" /> <!-- must only be in package-info: http://checkstyle.sourceforge.net/config_annotation.html#PackageAnnotation --> |
|
49 | 33 |
|
50 | 34 | <!-- Misc --> |
51 | 35 | <module name="ArrayTypeStyle" /> <!-- e.g. int[] array is ok int array[] not: http://checkstyle.sourceforge.net/config_misc.html#ArrayTypeStyle --> |
52 | | - <module name="MutableException" /> <!-- e.g. int[] array is ok int array[] not: http://checkstyle.sourceforge.net/config_misc.html#ArrayTypeStyle --> |
| 36 | + <module name="MutableException" /> <!-- exception classes must be immutable: http://checkstyle.sourceforge.net/config_design.html#MutableException --> |
53 | 37 | <module name="UpperEll" /> <!-- long values must be postfixed with 'L' not 'l': http://checkstyle.sourceforge.net/config_misc.html#UpperEll --> |
54 | 38 | <module name="Indentation"> <!-- Checks correct indentation of Java code: http://checkstyle.sourceforge.net/config_misc.html#Indentation --> |
55 | 39 | <property name="basicOffset" value="4" /> |
|
69 | 53 |
|
70 | 54 | <!-- Classes --> |
71 | 55 | <module name="FinalClass" /> <!-- class with only private constructor must be final: http://checkstyle.sourceforge.net/config_design.html#FinalClass --> |
72 | | - <module name="OneStatementPerLine" /> <!-- you cant write int i=1;int j=2; http://checkstyle.sourceforge.net/config_design.html#OneStatementPerLine --> |
73 | | - <module name="SimplifyBooleanReturn" /> <!-- directly return boolean doe not check and return http://checkstyle.sourceforge.net/config_design.html#SimplifyBooleanReturn --> |
74 | | - <module name="StringLiteralEquality" /> <!-- you cant write myString == "this" http://checkstyle.sourceforge.net/config_design.html#StringLiteralEquality --> |
| 56 | + <module name="OneStatementPerLine" /> <!-- you can't write int i=1;int j=2; http://checkstyle.sourceforge.net/config_design.html#OneStatementPerLine --> |
| 57 | + <module name="SimplifyBooleanReturn" /> <!-- directly return boolean does not check and return http://checkstyle.sourceforge.net/config_design.html#SimplifyBooleanReturn --> |
| 58 | + <module name="StringLiteralEquality" /> <!-- you can't write myString == "this" http://checkstyle.sourceforge.net/config_design.html#StringLiteralEquality --> |
75 | 59 | <module name="OneTopLevelClass" /> <!-- only one root class per file http://checkstyle.sourceforge.net/config_design.html#OneTopLevelClass --> |
76 | 60 | <module name="ThrowsCount"> <!-- max 5 throws definitions per method: http://checkstyle.sourceforge.net/config_design.html#ThrowsCount --> |
77 | 61 | <property name="max" value="5" /> |
|
80 | 64 | <module name="OuterTypeFilename" /> <!-- class Foo must be in Foo.java: http://checkstyle.sourceforge.net/config_misc.html#OuterTypeFilename --> |
81 | 65 |
|
82 | 66 | <module name="HideUtilityClassConstructor" /> <!-- utility class constructor must be private: http://checkstyle.sourceforge.net/config_design.html#HideUtilityClassConstructor --> |
83 | | - <!--<module name="VisibilityModifier"> <!– most members must be private http://checkstyle.sourceforge.net/config_design.html#VisibilityModifier –>--> |
84 | | - <!--<property name="protectedAllowed" value="true" />--> |
85 | | - <!--<property name="packageAllowed" value="true" />--> |
86 | | - <!--<property name="allowPublicImmutableFields" value="true" />--> |
87 | | - <!--<property name="allowPublicFinalFields" value="true" />--> |
88 | | - <!--<property name="publicMemberPattern" value="^TAG$|^CREATOR$" />--> |
89 | | - <!--</module>--> |
90 | 67 |
|
91 | 68 | <!-- Coding --> |
92 | 69 | <module name="CovariantEquals" /> <!-- if you override equals with different type you must provide equals with same type: http://checkstyle.sourceforge.net/config_coding.html#CovariantEquals --> |
93 | 70 | <module name="DefaultComesLast" /> <!-- in switch case default must be the last elem: http://checkstyle.sourceforge.net/config_coding.html#DefaultComesLast --> |
94 | 71 | <module name="EmptyStatement" /> <!-- basically an empty semicolon: http://checkstyle.sourceforge.net/config_coding.html#EmptyStatement --> |
95 | 72 | <module name="EqualsHashCode" /> <!-- if you implement equals, you must implement hashcode and vice versa: http://checkstyle.sourceforge.net/config_coding.html#EqualsHashCode --> |
96 | | - <module name="NoFinalizer" /> <!-- Verifies there are no finalize() methods defined in a class: http://checkstyle.sourceforge.net/config_coding.html#NoFinalizer --> |
97 | 73 | <module name="FallThrough" /> <!-- switch fallthrough with statement not allowed http://checkstyle.sourceforge.net/config_coding.html#FallThrough --> |
98 | 74 | <module name="IllegalInstantiation" /> <!-- Must not use const of certain types (Activity, Fragment): http://checkstyle.sourceforge.net/config_coding.html#IllegalInstantiation --> |
99 | 75 |
|
100 | 76 | <!-- Size Limitiations --> |
101 | | - <module name="LineLength"><!-- max char length per line http://checkstyle.sourceforge.net/config_sizes.html#LineLength --> |
102 | | - <property name="max" value="300" /> |
103 | | - </module> |
104 | 77 | <module name="MethodLength"><!-- max line length for single method http://checkstyle.sourceforge.net/config_sizes.html#MethodLength --> |
105 | 78 | <property name="max" value="200" /> |
106 | 79 | </module> |
|
0 commit comments