-
Notifications
You must be signed in to change notification settings - Fork 9
/
scalastyle-config.xml
176 lines (171 loc) · 8.97 KB
/
scalastyle-config.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<scalastyle>
<check level="warning" class="org.scalastyle.scalariform.ReturnChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.scalariform.ClassNamesChecker" enabled="true">
<parameters>
<parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.ObjectNamesChecker" enabled="true">
<parameters>
<parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.PackageObjectNamesChecker" enabled="true">
<parameters>
<parameter name="regex"><![CDATA[^[a-z][A-Za-z]*$]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.EqualsHashCodeChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.scalariform.IllegalImportsChecker" enabled="true">
<parameters>
<parameter name="illegalImports"><![CDATA[sun._,java.awt._]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.ParameterNumberChecker" enabled="true">
<parameters>
<parameter name="maxParameters"><![CDATA[8]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.MagicNumberChecker" enabled="false">
<parameters>
<!-- I've added 10,20,30 just because they are so prevelent that they generate a lot of noise, not because they are ok -->
<parameter name="ignore"><![CDATA[-1,0,1,2,3,10,20,30]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.NullChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.scalariform.NoCloneChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.scalariform.NoFinalizeChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.scalariform.CovariantEqualsChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.scalariform.StructuralTypeChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.file.RegexChecker" enabled="true">
<parameters>
<parameter name="regex"><![CDATA[println]]></parameter>
<customMessage>Use a logger instead of println</customMessage>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.NumberOfTypesChecker" enabled="true">
<parameters>
<parameter name="maxTypes"><![CDATA[30]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.CyclomaticComplexityChecker" enabled="true">
<parameters>
<parameter name="maximum"><![CDATA[13]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.UppercaseLChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.scalariform.SimplifyBooleanExpressionChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.scalariform.IfBraceChecker" enabled="true">
<parameters>
<parameter name="singleLineAllowed"><![CDATA[true]]></parameter>
<parameter name="doubleLineAllowed"><![CDATA[false]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.MethodLengthChecker" enabled="true">
<parameters>
<parameter name="maxLength"><![CDATA[75]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.MethodNamesChecker" enabled="true">
<parameters>
<parameter name="regex"><![CDATA[^[a-z*][A-Za-z0-9_]*$]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.NumberOfMethodsInTypeChecker" enabled="true">
<parameters>
<parameter name="maxMethods"><![CDATA[30]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.PublicMethodsHaveTypeChecker" enabled="true"></check>
<check level="warning" class="org.scalastyle.scalariform.ForBraceChecker" enabled="true"/>
<check enabled="false" class="org.scalastyle.scalariform.ClassTypeParameterChecker" level="warning">
<parameters>
<parameter name="regex">^[A-Z_]$</parameter>
</parameters>
</check>
<check enabled="true" class="org.scalastyle.scalariform.EmptyClassChecker" level="warning"/>
<check enabled="false" class="org.scalastyle.scalariform.LowercasePatternMatchChecker" level="warning"/>
<check enabled="true" class="org.scalastyle.scalariform.NotImplementedErrorUsage" level="warning"/>
<check enabled="false" class="org.scalastyle.scalariform.PatternMatchAlignChecker" level="warning"/>
<check enabled="true" class="org.scalastyle.scalariform.RedundantIfChecker" level="warning"/>
<checker enabled="true" class="org.scalastyle.scalariform.TodoCommentChecker" level="warning">
<parameters>
<parameter default="TODO|FIXME" type="string" name="words"/>
</parameters>
</checker>
<check enabled="true" class="org.scalastyle.scalariform.TokenChecker" level="warning">
<parameters>
<!-- original rule: <parameter name="regex">^[ai]sInstanceOf$</parameter> -->
<parameter name="regex">^asInstanceOf$</parameter>
</parameters>
<customMessage>Avoid casting.</customMessage>
</check>
<check enabled="true" class="org.scalastyle.scalariform.VarFieldChecker" level="warning"/>
<check enabled="true" class="org.scalastyle.scalariform.VarLocalChecker" level="warning"/>
<check enabled="true" class="org.scalastyle.file.RegexChecker" level="warning">
<parameters>
<parameter name="regex">(?m)^\s*$(\r|)\n^\s*$(\r|)\n</parameter>
<parameter name="line">false</parameter>
</parameters>
<customMessage>No double blank lines</customMessage>
</check>
<!--
Below are all disabled, not because they are not good checks but because I feel we would be
better to address the warning generated by the above errors first
-->
<check level="warning" class="org.scalastyle.file.FileTabChecker" enabled="false"></check>
<check level="warning" class="org.scalastyle.file.WhitespaceEndOfLineChecker" enabled="false"></check>
<check level="warning" class="org.scalastyle.file.FileLineLengthChecker" enabled="false">
<parameters>
<parameter name="maxLineLength"><![CDATA[160]]></parameter>
<parameter name="tabSize"><![CDATA[4]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.file.NewLineAtEofChecker" enabled="false"></check>
<check level="warning" class="org.scalastyle.file.NoNewLineAtEofChecker" enabled="false"></check>
<check enabled="false" class="org.scalastyle.file.IndentationChecker" level="warning">
<parameters>
<parameter name="tabSize">2</parameter>
<parameter name="methodParamIndentSize">2</parameter>
</parameters>
</check>
<check enabled="false" class="org.scalastyle.scalariform.FieldNamesChecker" level="warning">
<parameters>
<parameter name="regex">^[a-z\(][A-Za-z0-9,_]*\)?$</parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.file.FileLengthChecker" enabled="false">
<parameters>
<parameter name="maxFileLength"><![CDATA[800]]></parameter>
</parameters>
</check>
<check level="warning" class="org.scalastyle.scalariform.SpacesAfterPlusChecker" enabled="false"></check>
<check level="warning" class="org.scalastyle.scalariform.SpacesBeforePlusChecker" enabled="false"></check>
<check level="warning" class="org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker" enabled="false"></check>
<check level="warning" class="org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker" enabled="false"></check>
<check enabled="" class="org.scalastyle.scalariform.TokenChecker" level="warning">
<parameters>
<parameter name="regex">^(awaitResult|awaitAction)$</parameter>
</parameters>
<customMessage>Deprecated: Note that the awaitResult method will be deprecated in a future release</customMessage>
</check>
<check enabled="true" class="org.scalastyle.scalariform.TokenChecker" level="warning">
<parameters>
<parameter name="regex">^ServerError$</parameter>
</parameters>
<customMessage>We should not return a 500 error via Server error, as no sentry messages will be logged. Use Task.raiseError or helper like assert instead</customMessage>
</check>
<!-- Too many false positives -->
<check enabled="false" class="org.scalastyle.file.RegexChecker" level="warning">
<parameters>
<parameter name="regex">\.get</parameter>
<parameter name="line">false</parameter>
</parameters>
<customMessage>use fold or pattern matching on an Option</customMessage>
</check>
<check enabled="false" class="org.scalastyle.scalariform.MultipleStringLiteralsChecker" level="warning">
<parameters>
<parameter name="allowed">3</parameter>
</parameters>
</check>
</scalastyle>