xref: /XiangShan/scalastyle-test-config.xml (revision dc597826530cb6803c2396d6ab0e5eb176b732e0)
1<scalastyle>
2 <name>Scalastyle configuration for Chisel3 unit tests</name>
3 <check level="warning" class="org.scalastyle.file.FileTabChecker" enabled="true"></check>
4 <check level="warning" class="org.scalastyle.file.FileLengthChecker" enabled="true">
5  <parameters>
6   <parameter name="maxFileLength"><![CDATA[800]]></parameter>
7  </parameters>
8 </check>
9 <check level="warning" class="org.scalastyle.file.HeaderMatchesChecker" enabled="true">
10  <parameters>
11   <parameter name="header"><![CDATA[// See README.md for license details.]]></parameter>
12  </parameters>
13 </check>
14 <check level="warning" class="org.scalastyle.scalariform.SpacesAfterPlusChecker" enabled="true"></check>
15 <check level="warning" class="org.scalastyle.file.WhitespaceEndOfLineChecker" enabled="true"></check>
16 <check level="warning" class="org.scalastyle.scalariform.SpacesBeforePlusChecker" enabled="true"></check>
17 <check level="warning" class="org.scalastyle.file.FileLineLengthChecker" enabled="true">
18  <parameters>
19   <parameter name="maxLineLength"><![CDATA[120]]></parameter>
20   <parameter name="tabSize"><![CDATA[4]]></parameter>
21  </parameters>
22 </check>
23 <check level="warning" class="org.scalastyle.scalariform.ClassNamesChecker" enabled="true">
24  <parameters>
25   <parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
26  </parameters>
27 </check>
28 <check level="warning" class="org.scalastyle.scalariform.ObjectNamesChecker" enabled="true">
29  <parameters>
30   <parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
31  </parameters>
32 </check>
33 <check level="warning" class="org.scalastyle.scalariform.PackageObjectNamesChecker" enabled="true">
34  <parameters>
35   <parameter name="regex"><![CDATA[^[a-z][A-Za-z]*$]]></parameter>
36  </parameters>
37 </check>
38 <check level="warning" class="org.scalastyle.scalariform.EqualsHashCodeChecker" enabled="true"></check>
39 <check level="warning" class="org.scalastyle.scalariform.IllegalImportsChecker" enabled="true">
40  <parameters>
41   <parameter name="illegalImports"><![CDATA[sun._,java.awt._]]></parameter>
42  </parameters>
43 </check>
44 <check level="warning" class="org.scalastyle.scalariform.ParameterNumberChecker" enabled="true">
45  <parameters>
46   <parameter name="maxParameters"><![CDATA[8]]></parameter>
47  </parameters>
48 </check>
49 <!-- Numerical constants are used a lot in test setups, it would be burdensome to require each one be its own val
50 declaration. -->
51 <check level="warning" class="org.scalastyle.scalariform.MagicNumberChecker" enabled="false"></check>
52 <!-- Scalatest's exception checking syntax looks like "a [ChiselException] should be thrownBy". -->
53 <check level="warning" class="org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker" enabled="false"></check>
54 <check level="warning" class="org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker" enabled="true"></check>
55 <check level="warning" class="org.scalastyle.scalariform.ReturnChecker" enabled="false"></check>
56 <check level="warning" class="org.scalastyle.scalariform.NullChecker" enabled="false"></check>
57 <check level="warning" class="org.scalastyle.scalariform.NoCloneChecker" enabled="false"></check>
58 <check level="warning" class="org.scalastyle.scalariform.NoFinalizeChecker" enabled="true"></check>
59 <check level="warning" class="org.scalastyle.scalariform.CovariantEqualsChecker" enabled="true"></check>
60 <check level="warning" class="org.scalastyle.scalariform.StructuralTypeChecker" enabled="true"></check>
61 <check level="warning" class="org.scalastyle.file.RegexChecker" enabled="true">
62  <parameters>
63   <parameter name="regex"><![CDATA[^.*;(\r|)\n]]></parameter>
64  </parameters>
65  <customMessage>No lines ending with a ;</customMessage>
66 </check>
67 <check level="warning" class="org.scalastyle.file.RegexChecker" enabled="true">
68  <parameters>
69   <parameter name="regex"><![CDATA[println]]></parameter>
70  </parameters>
71 </check>
72 <check level="warning" class="org.scalastyle.scalariform.NumberOfTypesChecker" enabled="true">
73  <parameters>
74   <parameter name="maxTypes"><![CDATA[30]]></parameter>
75  </parameters>
76 </check>
77 <check level="warning" class="org.scalastyle.scalariform.CyclomaticComplexityChecker" enabled="true">
78  <parameters>
79   <parameter name="maximum"><![CDATA[10]]></parameter>
80  </parameters>
81 </check>
82 <check level="warning" class="org.scalastyle.scalariform.UppercaseLChecker" enabled="true"></check>
83 <check level="warning" class="org.scalastyle.scalariform.SimplifyBooleanExpressionChecker" enabled="true"></check>
84 <check level="warning" class="org.scalastyle.scalariform.IfBraceChecker" enabled="true">
85  <parameters>
86   <parameter name="singleLineAllowed"><![CDATA[true]]></parameter>
87   <parameter name="doubleLineAllowed"><![CDATA[false]]></parameter>
88  </parameters>
89 </check>
90 <check level="warning" class="org.scalastyle.scalariform.MethodLengthChecker" enabled="true">
91  <parameters>
92   <parameter name="maxLength"><![CDATA[50]]></parameter>
93  </parameters>
94 </check>
95 <check level="warning" class="org.scalastyle.scalariform.MethodNamesChecker" enabled="true">
96  <parameters>
97   <parameter name="regex"><![CDATA[^[a-z][A-Za-z0-9]*$]]></parameter>
98   <parameter name="ignoreRegex"><![CDATA[^(\+[&%]?|\-[&%]?|\*|/|%|&|\||\^|<|>|\|\||&&|:=|<>|<=|>=|!=|===|<<|>>|##|unary_(~|\-%?|!))$]]></parameter>
99  </parameters>
100 </check>
101 <check level="warning" class="org.scalastyle.scalariform.NumberOfMethodsInTypeChecker" enabled="true">
102  <parameters>
103   <parameter name="maxMethods"><![CDATA[30]]></parameter>
104  </parameters>
105 </check>
106 <check level="warning" class="org.scalastyle.scalariform.PublicMethodsHaveTypeChecker" enabled="true"></check>
107 <check level="warning" class="org.scalastyle.file.NewLineAtEofChecker" enabled="true"></check>
108 <check level="warning" class="org.scalastyle.file.NoNewLineAtEofChecker" enabled="false"></check>
109</scalastyle>
110