Scalastyle Scala代码风格检测

记录下Scalastyle规则，方便查询。内容比较多，使用Ctrl + F 输入需要查询的检查器进行搜索查询。

目录

介绍

规则

使用示例

Maven集成Scalastyle

Spark的Scalastyle-config.xml

---

介绍

Scalastyle 是专门针对Scala代码开发的轻巧的code style检测工具，类似于Java代码检查工具Checkstyle、Findbugs等。可以在Maven中集成到项目中，方便代码风格的检测。

最下面附上了Spark2.4.3的 Scalastyle 配置代码，可以借鉴。

Scalastyle常用关键字 //scalastyle:on 和 //scalastyle:off，如：

1.  
   //scalastyle:on println
2.  
   if (args.length < 2) {
3.  
   println("Usage:")
4.  
   println("DRIVER_MEMORY=[mem] spark-submit " +
5.  
   "com.github.ehiggs.spark.terasort.TeraGen " +
6.  
   "spark-terasort-1.0-SNAPSHOT-with-dependencies.jar " +
7.  
   "[output-size] [output-directory]")
8.  
   println(" ")
9.  
   println("Example:")
10.  
    println("DRIVER_MEMORY=50g spark-submit " +
11.  
    "com.github.ehiggs.spark.terasort.TeraGen " +
12.  
    "spark-terasort-1.0-SNAPSHOT-with-dependencies.jar " +
13.  
    "100G file:///scratch/username/terasort_in")
14.  
    System.exit(0)
15.  
    }
16.  
    //scalastyle:off println

规则

官网说明：已实现的规则 

目前已实现规则有69条

检查器	解释
org.scalastyle.file.FileLengthChecker	检查文件中的行数
org.scalastyle.file.FileLineLengthChecker	检查一行中的字符数
org.scalastyle.file.FileTabChecker	检查文件中是否有标签
org.scalastyle.file.HeaderMatchesChecker	检查每个文件的前几行与文本匹配
org.scalastyle.file.IndentationChecker	检查行是否由Tab的倍数缩进
org.scalastyle.file.NewLineAtEofChecker	检查文件是否以换行符结尾
org.scalastyle.file.NoNewLineAtEofChecker	检查文件不是以换行符结尾
org.scalastyle.file.RegexChecker	检查正则表达式是否匹配
org.scalastyle.file.WhitespaceEndOfLineChecker	检查行尾没有空格
org.scalastyle.scalariform.BlockImportChecker	检查导入块是否使用
org.scalastyle.scalariform.ClassNamesChecker	检查类名是否与正则表达式匹配
org.scalastyle.scalariform.ClassTypeParameterChecker	检查类的类型参数与正则表达式匹配
org.scalastyle.scalariform.CovariantEqualsChecker	检查类和对象在没有覆盖的情况下定义了相等(java.lang.object)
org.scalastyle.scalariform.CyclomaticComplexityChecker	检查方法的参数复杂度是否超过设定值
org.scalastyle.scalariform.DeprecatedJavaChecker	检查应该用Scala @deprecated代替Java @Deprecated
org.scalastyle.scalariform.DisallowSpaceAfterTokenChecker	检查某些既定标记后不允许使用空格
org.scalastyle.scalariform.DisallowSpaceBeforeTokenChecker	检查某些既定标记前不允许使用空格
org.scalastyle.scalariform.EmptyClassChecker	检查类或抽象类没有成员，则可以省略大括号
org.scalastyle.scalariform.EmptyInterpolatedStringChecker	检查是否有对字符串插入空值
org.scalastyle.scalariform.EnsureSingleSpaceAfterTokenChecker	检查某些既定标记后是否有空间
org.scalastyle.scalariform.EnsureSingleSpaceBeforeTokenChecker	检查某些既定标记前是否有空间
org.scalastyle.scalariform.EqualsHashCodeChecker	检查如果一个类实现了或等于Hash，那它应该实现另一个类
org.scalastyle.scalariform.FieldNamesChecker	检查字段名是否与正则表达式匹配
org.scalastyle.scalariform.ForBraceChecker	检查for是否使用大括号
org.scalastyle.scalariform.IfBraceChecker	检查if是否使用大括号
org.scalastyle.scalariform.IllegalImportsChecker	检查类没有导入某些类
org.scalastyle.scalariform.ImportGroupingChecker	检查导入是否分组
org.scalastyle.scalariform.ImportOrderChecker	检查是否根据样式配置对导入进行分组和排序
org.scalastyle.scalariform.LowercasePatternMatchChecker	检查case语句模式匹配是否为小写，因为这可能导致混淆
org.scalastyle.scalariform.MagicNumberChecker	检查魔数是否使用var定义
org.scalastyle.scalariform.MethodArgumentNamesChecker	检查方法参数名是否与正则表达式匹配
org.scalastyle.scalariform.MethodLengthChecker	检查方法不超过最大长度
org.scalastyle.scalariform.MethodNamesChecker	检查方法名是否与正则表达式匹配
org.scalastyle.scalariform.MultipleStringLiteralsChecker	检查字符串文字没有多次出现
org.scalastyle.scalariform.NamedArgumentChecker	检查参数是否命名
org.scalastyle.scalariform.NoCloneChecker	检查类和对象没有定义clone()方法
org.scalastyle.scalariform.NoFinalizeChecker	检查类和对象是否定义了Finish()方法
org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker	检查左括号‘[’后没有空格
org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker	检查左括号‘[’之前没有空格
org.scalastyle.scalariform.NoWhitespaceBeforeRightBracketChecker	检查右括号“]”之前没有空格
org.scalastyle.scalariform.NonASCIICharacterChecker	检查是否使用非ASCII字符（Unicode字符）
org.scalastyle.scalariform.NotImplementedErrorUsage	检查代码是否有 ??? 操作符
org.scalastyle.scalariform.NullChecker	检查是否使用NULL
org.scalastyle.scalariform.NumberOfMethodsInTypeChecker	检查一个类/特性/对象是否申明太多的方法
org.scalastyle.scalariform.NumberOfTypesChecker	检查文件中声明的类型是否过多
org.scalastyle.scalariform.ObjectNamesChecker	检查对象名称是否与正则表达式匹配
org.scalastyle.scalariform.OverrideJavaChecker	检查java@重写是否被使用
org.scalastyle.scalariform.PackageNamesChecker	检查包名是否与正则表达式匹配
org.scalastyle.scalariform.PackageObjectNamesChecker	检查包对象名是否与正则表达式匹配
org.scalastyle.scalariform.ParameterNumberChecker	检查方法的参数个数是否超过设置数量
org.scalastyle.scalariform.PatternMatchAlignChecker	检查模式匹配箭头对齐
org.scalastyle.scalariform.ProcedureDeclarationChecker	检查申明过程 a：unit= 是否使用=号
org.scalastyle.scalariform.PublicMethodsHaveTypeChecker	检查方法是否具有显式返回类型
org.scalastyle.scalariform.RedundantIfChecker	检查表达式是否是冗余，如，if (cond) false else true
org.scalastyle.scalariform.ReturnChecker	检查是否使用return
org.scalastyle.scalariform.ScalaDocChecker	检查代码格式是否遵循Scaladoc文档说明
org.scalastyle.scalariform.SimplifyBooleanExpressionChecker	检查Boolean表达式是否可以简化
org.scalastyle.scalariform.SpaceAfterCommentStartChecker	检查在注释后是否有一个空格
org.scalastyle.scalariform.SpacesAfterPlusChecker	检查加号后面是否有空格
org.scalastyle.scalariform.SpacesBeforePlusChecker	检查加号前面是否有空格
org.scalastyle.scalariform.StructuralTypeChecker	检查结构类型是否未被使用
org.scalastyle.scalariform.TodoCommentChecker	检查是否使用Todo/Fixme单行注释
org.scalastyle.scalariform.TokenChecker	检查如果有正则表达式，是否在特殊标记中匹配
org.scalastyle.scalariform.UnderscoreImportChecker	检查是否使用通配符导入
org.scalastyle.scalariform.UppercaseLChecker	检查如果使用长字符串，则使用大写字母
org.scalastyle.scalariform.VarFieldChecker	检查类和对象是否定义可变字段
org.scalastyle.scalariform.VarLocalChecker	检查函数是否定义可变变量
org.scalastyle.scalariform.WhileChecker	检查是否使用While循环
org.scalastyle.scalariform.XmlLiteralChecker	检查是否未使用xml文本

使用示例

主要在 scalastyle-config.xml 中设置。

 org.scalastyle.file.FileLengthChecker    检查文件中的行数

1.  
   <check enabled="true" class="org.scalastyle.file.FileLengthChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="maxFileLength">800</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.file.FileLineLengthChecker    检查一行中的字符数

1.  
   <check enabled="true" class="org.scalastyle.file.FileLineLengthChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="maxLineLength">100</parameter>
4.  
   <parameter name="tabSize">2</parameter>
5.  
   <parameter name="ignoreImports">true</parameter>
6.  
   </parameters>
7.  
   </check>

org.scalastyle.file.FileTabChecker    检查文件中是否有标签

<check enabled="true" class="org.scalastyle.file.FileTabChecker" level="warning"/>

org.scalastyle.file.HeaderMatchesChecker    检查每个文件的前几行与文本匹配

1.  
   <check enabled="true" class="org.scalastyle.file.HeaderMatchesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">false</parameter>
4.  
   <parameter name="header">// Copyright \(C\) 2011-2012 the original author or authors.</parameter>
5.  
   </parameters>
6.  
   </check>

或者 

1.  
   <check enabled="true" class="org.scalastyle.file.HeaderMatchesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">true</parameter>
4.  
   <parameter name="header">// Copyright \(C\) (?:\d{4}-)?\d{4} the original author or authors.</parameter>
5.  
   </parameters>
6.  
   </check>

org.scalastyle.file.IndentationChecker    检查行是否由Tab的倍数缩进

1.  
   <check enabled="true" class="org.scalastyle.file.IndentationChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="tabSize">2</parameter>
4.  
   <parameter name="methodParamIndentSize">2</parameter>
5.  
   <parameter name="classParamIndentSize">4</parameter>
6.  
   </parameters>
7.  
   </check>

org.scalastyle.file.NewLineAtEofChecker    检查文件是否以换行符结尾

<check enabled="true" class="org.scalastyle.file.NewLineAtEofChecker" level="warning"/>

org.scalastyle.file.NoNewLineAtEofChecker    检查文件不是以换行符结尾

<check enabled="true" class="org.scalastyle.file.NoNewLineAtEofChecker" level="warning"/>

org.scalastyle.file.RegexChecker    检查正则表达式是否匹配

1.  
   <check enabled="true" class="org.scalastyle.file.RegexChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">(?m)^\s*$(\r|)\n^\s*$(\r|)\n</parameter>
4.  
   <parameter name="line">false</parameter>
5.  
   </parameters>
6.  
   <customMessage>No double blank lines</customMessage>
7.  
   </check>

org.scalastyle.file.WhitespaceEndOfLineChecker    检查行尾没有空格

1.  
   <check enabled="true" class="org.scalastyle.file.WhitespaceEndOfLineChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter default="false" type="boolean" name="ignoreWhitespaceLines"/>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.BlockImportChecker    检查导入块是否使用

<check enabled="true" class="org.scalastyle.scalariform.BlockImportChecker" level="warning"/>

org.scalastyle.scalariform.ClassNamesChecker    检查类名是否与正则表达式匹配

1.  
   <check enabled="true" class="org.scalastyle.scalariform.ClassNamesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">^[A-Z][A-Za-z]*$</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.ClassTypeParameterChecker    检查类的类型参数与正则表达式匹配

1.  
   <check enabled="true" class="org.scalastyle.scalariform.ClassTypeParameterChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">^[A-Z_]$</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.CovariantEqualsChecker    检查类和对象在没有覆盖的情况下定义了相等(java.lang.object)

<check enabled="true" class="org.scalastyle.scalariform.CovariantEqualsChecker" level="warning"/>

org.scalastyle.scalariform.CyclomaticComplexityChecker    检查方法的参数复杂度是否超过设定值

1.  
   <check enabled="true" class="org.scalastyle.scalariform.CyclomaticComplexityChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="maximum">10</parameter>
4.  
   <parameter name="countCases">true</parameter>
5.  
   </parameters>
6.  
   </check>

org.scalastyle.scalariform.DeprecatedJavaChecker    检查应该用Scala @deprecated代替Java @Deprecated

<check enabled="true" class="org.scalastyle.scalariform.DeprecatedJavaChecker" level="warning"/>

org.scalastyle.scalariform.DisallowSpaceAfterTokenChecker    检查某些既定标记后不允许使用空格

1.  
   <check enabled="true" class="org.scalastyle.scalariform.DisallowSpaceAfterTokenChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="tokens">LPAREN</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.DisallowSpaceBeforeTokenChecker    检查某些既定标记前不允许使用空格

1.  
   <check enabled="true" class="org.scalastyle.scalariform.DisallowSpaceBeforeTokenChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="tokens">COLON, COMMA, RPAREN</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.EmptyClassChecker    检查类或抽象类没有成员，则可以省略大括号

<check enabled="true" class="org.scalastyle.scalariform.EmptyClassChecker" level="warning"/>

org.scalastyle.scalariform.EmptyInterpolatedStringChecker    检查是否有对字符串插入空值

<check enabled="true" level="warning" class="org.scalastyle.scalariform.EmptyInterpolatedStringChecker"/>

org.scalastyle.scalariform.EnsureSingleSpaceAfterTokenChecker    检查某些既定标记后是否有空间

1.  
   <check enabled="true" class="org.scalastyle.scalariform.EnsureSingleSpaceAfterTokenChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="tokens">COLON, IF</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.EnsureSingleSpaceBeforeTokenChecker    检查某些既定标记前是否有空间

1.  
   <check enabled="true" class="org.scalastyle.scalariform.EnsureSingleSpaceBeforeTokenChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="tokens">LPAREN</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.EqualsHashCodeChecker    检查如果一个类实现了或等于Hash，那它应该实现另一个类

<check enabled="true" class="org.scalastyle.scalariform.EqualsHashCodeChecker" level="warning"/>

org.scalastyle.scalariform.FieldNamesChecker    检查字段名是否与正则表达式匹配

1.  
   <check enabled="true" class="org.scalastyle.scalariform.FieldNamesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">^[a-z][A-Za-z0-9]*$</parameter>
4.  
   <parameter name="objectFieldRegex">^[A-Z][A-Za-z0-9]*$</parameter>
5.  
   </parameters>
6.  
   </check>

org.scalastyle.scalariform.ForBraceChecker    检查for是否使用大括号

<check enabled="true" class="org.scalastyle.scalariform.ForBraceChecker" level="warning"/>

org.scalastyle.scalariform.IfBraceChecker    检查if是否使用大括号

1.  
   <check enabled="true" class="org.scalastyle.scalariform.IfBraceChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="singleLineAllowed">true</parameter>
4.  
   <parameter name="doubleLineAllowed">false</parameter>
5.  
   </parameters>
6.  
   </check>

org.scalastyle.scalariform.IllegalImportsChecker    检查类没有导入某些类

<check enabled="true" class="org.scalastyle.scalariform.IllegalImportsChecker" level="warning"/>

org.scalastyle.scalariform.ImportGroupingChecker    检查导入是否分组

<check enabled="true" class="org.scalastyle.scalariform.ImportGroupingChecker" level="warning"/>

org.scalastyle.scalariform.ImportOrderChecker    检查是否根据样式配置对导入进行分组和排序

1.  
   <check enabled="true" class="org.scalastyle.scalariform.ImportOrderChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="groups">java,scala,others</parameter>
4.  
   <parameter name="group.java">javax?\..+</parameter>
5.  
   <parameter name="group.scala">scala\..+</parameter>
6.  
   <parameter name="group.others">.+</parameter>
7.  
   </parameters>
8.  
   </check>

org.scalastyle.scalariform.LowercasePatternMatchChecker    检查case语句模式匹配是否为小写，因为这可能导致混淆

<check enabled="true" class="org.scalastyle.scalariform.LowercasePatternMatchChecker" level="warning"/>

org.scalastyle.scalariform.MagicNumberChecker    检查魔数是否使用var定义

1.  
   <check enabled="true" class="org.scalastyle.scalariform.MagicNumberChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="ignore">-1,0,1,2,3</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.MethodArgumentNamesChecker    检查方法参数名是否与正则表达式匹配

1.  
   <check enabled="true" class="org.scalastyle.scalariform.MethodArgumentNamesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">^[a-z][A-Za-z0-9]*$</parameter>
4.  
   <parameter name="ignoreRegex">^$</parameter>
5.  
   </parameters>
6.  
   </check>

org.scalastyle.scalariform.MethodLengthChecker    检查方法不超过最大长度

1.  
   <check enabled="true" class="org.scalastyle.scalariform.MethodLengthChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="maxLength">50</parameter>
4.  
   <parameter name="ignoreComments">false</parameter>
5.  
   </parameters>
6.  
   </check>

org.scalastyle.scalariform.MethodNamesChecker    检查方法名是否与正则表达式匹配

1.  
   <check enabled="true" class="org.scalastyle.scalariform.MethodNamesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">^[A-Za-z]*$</parameter>
4.  
   <parameter name="ignoreRegex">^.*$</parameter>
5.  
   <parameter name="ignoreOverride">false</parameter>
6.  
   </parameters>
7.  
   </check>

org.scalastyle.scalariform.MultipleStringLiteralsChecker    检查字符串文字没有多次出现

1.  
   <check enabled="true" class="org.scalastyle.scalariform.MultipleStringLiteralsChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="allowed">1</parameter>
4.  
   <parameter name="ignoreRegex">^\&quot;\&quot;$</parameter>
5.  
   </parameters>
6.  
   </check>

org.scalastyle.scalariform.NamedArgumentChecker    检查参数是否命名

1.  
   <check enabled="true" class="org.scalastyle.scalariform.NamedArgumentChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="checkString">false</parameter>
4.  
   <parameter name="ignoreMethod">^set.+$</parameter>
5.  
   </parameters>
6.  
   </check>

org.scalastyle.scalariform.NoCloneChecker    检查类和对象没有定义clone()方法

<check enabled="true" class="org.scalastyle.scalariform.NoCloneChecker" level="warning"/>

org.scalastyle.scalariform.NoFinalizeChecker    检查类和对象是否定义了Finish()方法

<check enabled="true" class="org.scalastyle.scalariform.NoFinalizeChecker" level="warning"/>

org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker    检查左括号‘[’后没有空格

<check enabled="true" class="org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker" level="warning"/>

org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker    检查左括号‘[’之前没有空格

<check enabled="true" class="org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker" level="warning"/>

org.scalastyle.scalariform.NoWhitespaceBeforeRightBracketChecker    检查右括号“]”之前没有空格

<check enabled="true" class="org.scalastyle.scalariform.NoWhitespaceBeforeRightBracketChecker" level="warning"/>

org.scalastyle.scalariform.NonASCIICharacterChecker    检查是否使用非ASCII字符（Unicode字符）

<check enabled="true" class="org.scalastyle.scalariform.NonASCIICharacterChecker" level="warning"/>

org.scalastyle.scalariform.NotImplementedErrorUsage    检查代码是否有 ??? 操作符

<check enabled="true" class="org.scalastyle.scalariform.NotImplementedErrorUsage" level="warning"/>

org.scalastyle.scalariform.NullChecker    检查是否使用NULL

1.  
   <check enabled="true" class="org.scalastyle.scalariform.NullChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="allowNullChecks">true</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.NumberOfMethodsInTypeChecker    检查一个类/特性/对象是否申明太多的方法

1.  
   <check enabled="true" class="org.scalastyle.scalariform.NumberOfMethodsInTypeChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="maxMethods">30</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.NumberOfTypesChecker    检查文件中声明的类型是否过多

1.  
   <check enabled="true" class="org.scalastyle.scalariform.NumberOfTypesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="maxTypes">20</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.ObjectNamesChecker    检查对象名称是否与正则表达式匹配

1.  
   <check enabled="true" class="org.scalastyle.scalariform.ObjectNamesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">^[A-Z][A-Za-z]*$</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.OverrideJavaChecker    检查java@重写是否被使用

<check enabled="true" class="org.scalastyle.scalariform.OverrideJavaChecker" level="warning"/>

org.scalastyle.scalariform.PackageNamesChecker    检查包名是否与正则表达式匹配

1.  
   <check enabled="true" class="org.scalastyle.scalariform.PackageNamesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">^[a-z][A-Za-z]*$</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.PackageObjectNamesChecker    检查包对象名是否与正则表达式匹配

1.  
   <check enabled="true" class="org.scalastyle.scalariform.PackageObjectNamesChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">^[a-z][A-Za-z]*$</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.ParameterNumberChecker    检查方法的参数个数是否超过设置数量

1.  
   <check enabled="true" class="org.scalastyle.scalariform.ParameterNumberChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="maxParameters">8</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.PatternMatchAlignChecker    检查模式匹配箭头对齐

<check enabled="true" class="org.scalastyle.scalariform.PatternMatchAlignChecker" level="warning"/>

org.scalastyle.scalariform.ProcedureDeclarationChecker    检查申明过程 a：unit= 是否使用=号

<check enabled="true" class="org.scalastyle.scalariform.ProcedureDeclarationChecker" level="warning"/>

org.scalastyle.scalariform.PublicMethodsHaveTypeChecker    检查方法是否具有显式返回类型

1.  
   <check enabled="true" class="org.scalastyle.scalariform.PublicMethodsHaveTypeChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="ignoreOverride">false</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.RedundantIfChecker    检查表达式是否是冗余，如，if (cond) false else true

<check enabled="true" class="org.scalastyle.scalariform.RedundantIfChecker" level="warning"/>

org.scalastyle.scalariform.ReturnChecker    检查是否使用return

<check enabled="true" class="org.scalastyle.scalariform.ReturnChecker" level="warning"/>

org.scalastyle.scalariform.ScalaDocChecker    检查代码格式是否遵循Scaladoc文档说明

1.  
   <check enabled="true" class="org.scalastyle.scalariform.ScalaDocChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="ignoreRegex">(.*Spec$)|(.*SpecIT$)</parameter>
4.  
   <parameter name="ignoreTokenTypes">PatDefOrDcl,TypeDefOrDcl,FunDefOrDcl,TmplDef</parameter>
5.  
   <parameter name="ignoreOverride">false</parameter>
6.  
   <parameter name="indentStyle">anydoc</parameter>
7.  
   </parameters>
8.  
   </check>

org.scalastyle.scalariform.SimplifyBooleanExpressionChecker    检查Boolean表达式是否可以简化

<check enabled="true" class="org.scalastyle.scalariform.SimplifyBooleanExpressionChecker" level="warning"/>

org.scalastyle.scalariform.SpaceAfterCommentStartChecker    检查在注释后是否有一个空格

<check enabled="true" class="org.scalastyle.scalariform.SpaceAfterCommentStartChecker" level="warning"/>

org.scalastyle.scalariform.SpacesAfterPlusChecker    检查加号后面是否有空格

<check enabled="true" class="org.scalastyle.scalariform.SpacesAfterPlusChecker" level="warning"/>

org.scalastyle.scalariform.SpacesBeforePlusChecker    检查加号前面是否有空格

<check enabled="true" class="org.scalastyle.scalariform.SpacesBeforePlusChecker" level="warning"/>

org.scalastyle.scalariform.StructuralTypeChecker    检查结构类型是否未被使用

<check enabled="true" class="org.scalastyle.scalariform.StructuralTypeChecker" level="warning"/>

org.scalastyle.scalariform.TodoCommentChecker    检查是否使用Todo/Fixme单行注释

1.  
   <check enabled="true" class="org.scalastyle.scalariform.TodoCommentChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter default="TODO|FIXME" type="string" name="words"/>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.TokenChecker    检查如果有正则表达式，是否在特殊标记中匹配

1.  
   <check enabled="true" class="org.scalastyle.scalariform.TokenChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="regex">^[ai]sInstanceOf$</parameter>
4.  
   </parameters>
5.  
   <customMessage>Avoid casting.</customMessage>
6.  
   </check>

org.scalastyle.scalariform.UnderscoreImportChecker    检查是否使用通配符导入

1.  
   <check enabled="true" class="org.scalastyle.scalariform.UnderscoreImportChecker" level="warning">
2.  
   <parameters>
3.  
   <parameter name="ignoreRegex">collection\.JavaConverters\._|scala\.concurrent\.duration\._</parameter>
4.  
   </parameters>
5.  
   </check>

org.scalastyle.scalariform.UppercaseLChecker    检查如果使用长字符串，则使用大写字母

<check enabled="true" class="org.scalastyle.scalariform.UppercaseLChecker" level="warning"/>

org.scalastyle.scalariform.VarFieldChecker    检查类和对象是否定义可变字段

<check enabled="true" class="org.scalastyle.scalariform.VarFieldChecker" level="warning"/>

org.scalastyle.scalariform.VarLocalChecker    检查函数是否定义可变变量

<check enabled="true" class="org.scalastyle.scalariform.VarLocalChecker" level="warning"/>

org.scalastyle.scalariform.WhileChecker    检查是否使用While循环

<check enabled="true" class="org.scalastyle.scalariform.WhileChecker" level="warning"/>

org.scalastyle.scalariform.XmlLiteralChecker    检查是否未使用xml文本

<check enabled="true" class="org.scalastyle.scalariform.XmlLiteralChecker" level="warning"/>

 

Maven集成Scalastyle

如Spark的pom.xml中集成Scalastyle。

1.  
   <build>
2.  
   <plugins>
3.  
   ...
4.  
   <plugin>
5.  
   <groupId>org.scalastyle</groupId>
6.  
   <artifactId>scalastyle-maven-plugin</artifactId>
7.  
   <version>1.0.0</version>
8.  
   <configuration>
9.  
   <verbose>false</verbose>
10.  
    <failOnViolation>true</failOnViolation>
11.  
    <includeTestSourceDirectory>false</includeTestSourceDirectory>
12.  
    <failOnWarning>false</failOnWarning>
13.  
    <sourceDirectory>${basedir}/src/main/scala</sourceDirectory>
14.  
    <testSourceDirectory>${basedir}/src/test/scala</testSourceDirectory>
15.  
    <configLocation>scalastyle-config.xml</configLocation>
16.  
    <outputFile>${basedir}/target/scalastyle-output.xml</outputFile>
17.  
    <inputEncoding>${project.build.sourceEncoding}</inputEncoding>
18.  
    <outputEncoding>${project.reporting.outputEncoding}</outputEncoding>
19.  
    </configuration>
20.  
    <executions>
21.  
    <execution>
22.  
    <goals>
23.  
    <goal>check</goal>
24.  
    </goals>
25.  
    </execution>
26.  
    </executions>
27.  
    </plugin>
28.  
    ...
29.  
    </plugins>
30.  
    </build>

也可以将<sourceDirectories>设置多个目录。

1.  
   <sourceDirectories>
2.  
   <dir>${project.basedir}/src/main/scala</dir>
3.  
   <dir>${project.basedir}/src/main/generated-scala</dir>
4.  
   </sourceDirectories>

IDEA下可以设置风格检测

 

Spark2.4.3 的 Scalastyle-config.xml

1.  
   If you wish to turn off checking for a section of code, you can put a comment in the source
2.  
   before and after the section, with the following syntax:
3.  
    
4.  
   // scalastyle:off
5.  
   ... // stuff that breaks the styles
6.  
   // scalastyle:on
7.  
    
8.  
   You can also disable only one rule, by specifying its rule id, as specified in:
9.  
   http://www.scalastyle.org/rules-0.7.0.html
10.  
     
11.  
    // scalastyle:off no.finalize
12.  
    override def finalize(): Unit = ...
13.  
    // scalastyle:on no.finalize
14.  
     
15.  
    This file is divided into 3 sections:
16.  
    (1) rules that we enforce.
17.  
    (2) rules that we would like to enforce, but haven't cleaned up the codebase to turn on yet
18.  
    (or we need to make the scalastyle rule more configurable).
19.  
    (3) rules that we don't want to enforce.
20.  
    -->
21.  
     
22.  
    <scalastyle>
23.  
    <name>Scalastyle standard configuration</name>
24.  
     
25.  
    <!-- ================================================================================ -->
26.  
    <!-- rules we enforce -->
27.  
    <!-- ================================================================================ -->
28.  
     
29.  
    <check level="error" class="org.scalastyle.file.FileTabChecker" enabled="true"></check>
30.  
     
31.  
    <check level="error" class="org.scalastyle.file.HeaderMatchesChecker" enabled="true">
32.  
    <parameters>
33.  
    <parameter name="header"><![CDATA[/*
34.  
    * Licensed to the Apache Software Foundation (ASF) under one or more
35.  
    * contributor license agreements. See the NOTICE file distributed with
36.  
    * this work for additional information regarding copyright ownership.
37.  
    * The ASF licenses this file to You under the Apache License, Version 2.0
38.  
    * (the "License"); you may not use this file except in compliance with
39.  
    * the License. You may obtain a copy of the License at
40.  
    *
41.  
    * http://www.apache.org/licenses/LICENSE-2.0
42.  
    *
43.  
    * Unless required by applicable law or agreed to in writing, software
44.  
    * distributed under the License is distributed on an "AS IS" BASIS,
45.  
    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
46.  
    * See the License for the specific language governing permissions and
47.  
    * limitations under the License.
48.  
    */]]></parameter>
49.  
    </parameters>
50.  
    </check>
51.  
     
52.  
    <check level="error" class="org.scalastyle.scalariform.SpacesAfterPlusChecker" enabled="true"></check>
53.  
     
54.  
    <check level="error" class="org.scalastyle.scalariform.SpacesBeforePlusChecker" enabled="true"></check>
55.  
     
56.  
    <check level="error" class="org.scalastyle.file.WhitespaceEndOfLineChecker" enabled="true"></check>
57.  
     
58.  
    <check level="error" class="org.scalastyle.file.FileLineLengthChecker" enabled="true">
59.  
    <parameters>
60.  
    <parameter name="maxLineLength"><![CDATA[100]]></parameter>
61.  
    <parameter name="tabSize"><![CDATA[2]]></parameter>
62.  
    <parameter name="ignoreImports">true</parameter>
63.  
    </parameters>
64.  
    </check>
65.  
     
66.  
    <check level="error" class="org.scalastyle.scalariform.ClassNamesChecker" enabled="true">
67.  
    <parameters><parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter></parameters>
68.  
    </check>
69.  
     
70.  
    <check level="error" class="org.scalastyle.scalariform.ObjectNamesChecker" enabled="true">
71.  
    <parameters><parameter name="regex"><![CDATA[(config|[A-Z][A-Za-z]*)]]></parameter></parameters>
72.  
    </check>
73.  
     
74.  
    <check level="error" class="org.scalastyle.scalariform.PackageObjectNamesChecker" enabled="true">
75.  
    <parameters><parameter name="regex"><![CDATA[^[a-z][A-Za-z]*$]]></parameter></parameters>
76.  
    </check>
77.  
     
78.  
    <check customId="argcount" level="error" class="org.scalastyle.scalariform.ParameterNumberChecker" enabled="true">
79.  
    <parameters><parameter name="maxParameters"><![CDATA[10]]></parameter></parameters>
80.  
    </check>
81.  
     
82.  
    <check level="error" class="org.scalastyle.scalariform.NoFinalizeChecker" enabled="true"></check>
83.  
     
84.  
    <check level="error" class="org.scalastyle.scalariform.CovariantEqualsChecker" enabled="true"></check>
85.  
     
86.  
    <check level="error" class="org.scalastyle.scalariform.StructuralTypeChecker" enabled="true"></check>
87.  
     
88.  
    <check level="error" class="org.scalastyle.scalariform.UppercaseLChecker" enabled="true"></check>
89.  
     
90.  
    <check level="error" class="org.scalastyle.scalariform.IfBraceChecker" enabled="true">
91.  
    <parameters>
92.  
    <parameter name="singleLineAllowed"><![CDATA[true]]></parameter>
93.  
    <parameter name="doubleLineAllowed"><![CDATA[true]]></parameter>
94.  
    </parameters>
95.  
    </check>
96.  
     
97.  
    <check level="error" class="org.scalastyle.scalariform.PublicMethodsHaveTypeChecker" enabled="true"></check>
98.  
     
99.  
    <check level="error" class="org.scalastyle.file.NewLineAtEofChecker" enabled="true"></check>
100.  
      
101.  
     <check customId="nonascii" level="error" class="org.scalastyle.scalariform.NonASCIICharacterChecker" enabled="true"></check>
102.  
      
103.  
     <check level="error" class="org.scalastyle.scalariform.SpaceAfterCommentStartChecker" enabled="true"></check>
104.  
      
105.  
     <check level="error" class="org.scalastyle.scalariform.EnsureSingleSpaceBeforeTokenChecker" enabled="true">
106.  
     <parameters>
107.  
     <parameter name="tokens">ARROW, EQUALS, ELSE, TRY, CATCH, FINALLY, LARROW, RARROW</parameter>
108.  
     </parameters>
109.  
     </check>
110.  
      
111.  
     <check level="error" class="org.scalastyle.scalariform.EnsureSingleSpaceAfterTokenChecker" enabled="true">
112.  
     <parameters>
113.  
     <parameter name="tokens">ARROW, EQUALS, COMMA, COLON, IF, ELSE, DO, WHILE, FOR, MATCH, TRY, CATCH, FINALLY, LARROW, RARROW</parameter>
114.  
     </parameters>
115.  
     </check>
116.  
      
117.  
     <!-- ??? usually shouldn't be checked into the code base. -->
118.  
     <check level="error" class="org.scalastyle.scalariform.NotImplementedErrorUsage" enabled="true"></check>
119.  
      
120.  
     <!-- As of SPARK-7558, all tests in Spark should extend o.a.s.SparkFunSuite instead of FunSuite directly -->
121.  
     <check customId="funsuite" level="error" class="org.scalastyle.scalariform.TokenChecker" enabled="true">
122.  
     <parameters><parameter name="regex">^FunSuite[A-Za-z]*$</parameter></parameters>
123.  
     <customMessage>Tests must extend org.apache.spark.SparkFunSuite instead.</customMessage>
124.  
     </check>
125.  
      
126.  
     <!-- As of SPARK-7977 all printlns need to be wrapped in '// scalastyle:off/on println' -->
127.  
     <check customId="println" level="error" class="org.scalastyle.scalariform.TokenChecker" enabled="true">
128.  
     <parameters><parameter name="regex">^println$</parameter></parameters>
129.  
     <customMessage><![CDATA[Are you sure you want to println? If yes, wrap the code block with
130.  
     // scalastyle:off println
131.  
     println(...)
132.  
     // scalastyle:on println]]></customMessage>
133.  
     </check>
134.  
      
135.  
     <check customId="hadoopconfiguration" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
136.  
     <parameters><parameter name="regex">spark(.sqlContext)?.sparkContext.hadoopConfiguration</parameter></parameters>
137.  
     <customMessage><![CDATA[
138.  
     Are you sure that you want to use sparkContext.hadoopConfiguration? In most cases, you should use
139.  
     spark.sessionState.newHadoopConf() instead, so that the hadoop configurations specified in Spark session
140.  
     configuration will come into effect.
141.  
     If you must use sparkContext.hadoopConfiguration, wrap the code block with
142.  
     // scalastyle:off hadoopconfiguration
143.  
     spark.sparkContext.hadoopConfiguration...
144.  
     // scalastyle:on hadoopconfiguration
145.  
     ]]></customMessage>
146.  
     </check>
147.  
      
148.  
     <check customId="visiblefortesting" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
149.  
     <parameters><parameter name="regex">@VisibleForTesting</parameter></parameters>
150.  
     <customMessage><![CDATA[
151.  
     @VisibleForTesting causes classpath issues. Please note this in the java doc instead (SPARK-11615).
152.  
     ]]></customMessage>
153.  
     </check>
154.  
      
155.  
     <check customId="runtimeaddshutdownhook" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
156.  
     <parameters><parameter name="regex">Runtime\.getRuntime\.addShutdownHook</parameter></parameters>
157.  
     <customMessage><![CDATA[
158.  
     Are you sure that you want to use Runtime.getRuntime.addShutdownHook? In most cases, you should use
159.  
     ShutdownHookManager.addShutdownHook instead.
160.  
     If you must use Runtime.getRuntime.addShutdownHook, wrap the code block with
161.  
     // scalastyle:off runtimeaddshutdownhook
162.  
     Runtime.getRuntime.addShutdownHook(...)
163.  
     // scalastyle:on runtimeaddshutdownhook
164.  
     ]]></customMessage>
165.  
     </check>
166.  
      
167.  
     <check customId="mutablesynchronizedbuffer" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
168.  
     <parameters><parameter name="regex">mutable\.SynchronizedBuffer</parameter></parameters>
169.  
     <customMessage><![CDATA[
170.  
     Are you sure that you want to use mutable.SynchronizedBuffer? In most cases, you should use
171.  
     java.util.concurrent.ConcurrentLinkedQueue instead.
172.  
     If you must use mutable.SynchronizedBuffer, wrap the code block with
173.  
     // scalastyle:off mutablesynchronizedbuffer
174.  
     mutable.SynchronizedBuffer[...]
175.  
     // scalastyle:on mutablesynchronizedbuffer
176.  
     ]]></customMessage>
177.  
     </check>
178.  
      
179.  
     <check customId="classforname" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
180.  
     <parameters><parameter name="regex">Class\.forName</parameter></parameters>
181.  
     <customMessage><![CDATA[
182.  
     Are you sure that you want to use Class.forName? In most cases, you should use Utils.classForName instead.
183.  
     If you must use Class.forName, wrap the code block with
184.  
     // scalastyle:off classforname
185.  
     Class.forName(...)
186.  
     // scalastyle:on classforname
187.  
     ]]></customMessage>
188.  
     </check>
189.  
      
190.  
     <check customId="awaitresult" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
191.  
     <parameters><parameter name="regex">Await\.result</parameter></parameters>
192.  
     <customMessage><![CDATA[
193.  
     Are you sure that you want to use Await.result? In most cases, you should use ThreadUtils.awaitResult instead.
194.  
     If you must use Await.result, wrap the code block with
195.  
     // scalastyle:off awaitresult
196.  
     Await.result(...)
197.  
     // scalastyle:on awaitresult
198.  
     ]]></customMessage>
199.  
     </check>
200.  
      
201.  
     <check customId="awaitready" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
202.  
     <parameters><parameter name="regex">Await\.ready</parameter></parameters>
203.  
     <customMessage><![CDATA[
204.  
     Are you sure that you want to use Await.ready? In most cases, you should use ThreadUtils.awaitReady instead.
205.  
     If you must use Await.ready, wrap the code block with
206.  
     // scalastyle:off awaitready
207.  
     Await.ready(...)
208.  
     // scalastyle:on awaitready
209.  
     ]]></customMessage>
210.  
     </check>
211.  
      
212.  
     <!-- As of SPARK-9613 JavaConversions should be replaced with JavaConverters -->
213.  
     <check customId="javaconversions" level="error" class="org.scalastyle.scalariform.TokenChecker" enabled="true">
214.  
     <parameters><parameter name="regex">JavaConversions</parameter></parameters>
215.  
     <customMessage>Instead of importing implicits in scala.collection.JavaConversions._, import
216.  
     scala.collection.JavaConverters._ and use .asScala / .asJava methods</customMessage>
217.  
     </check>
218.  
      
219.  
     <check customId="commonslang2" level="error" class="org.scalastyle.scalariform.TokenChecker" enabled="true">
220.  
     <parameters><parameter name="regex">org\.apache\.commons\.lang\.</parameter></parameters>
221.  
     <customMessage>Use Commons Lang 3 classes (package org.apache.commons.lang3.*) instead
222.  
     of Commons Lang 2 (package org.apache.commons.lang.*)</customMessage>
223.  
     </check>
224.  
      
225.  
     <check customId="extractopt" level="error" class="org.scalastyle.scalariform.TokenChecker" enabled="true">
226.  
     <parameters><parameter name="regex">extractOpt</parameter></parameters>
227.  
     <customMessage>Use jsonOption(x).map(.extract[T]) instead of .extractOpt[T], as the latter
228.  
     is slower. </customMessage>
229.  
     </check>
230.  
      
231.  
     <check level="error" class="org.scalastyle.scalariform.ImportOrderChecker" enabled="true">
232.  
     <parameters>
233.  
     <parameter name="groups">java,scala,3rdParty,spark</parameter>
234.  
     <parameter name="group.java">javax?\..*</parameter>
235.  
     <parameter name="group.scala">scala\..*</parameter>
236.  
     <parameter name="group.3rdParty">(?!org\.apache\.spark\.).*</parameter>
237.  
     <parameter name="group.spark">org\.apache\.spark\..*</parameter>
238.  
     </parameters>
239.  
     </check>
240.  
      
241.  
     <check level="error" class="org.scalastyle.scalariform.DisallowSpaceBeforeTokenChecker" enabled="true">
242.  
     <parameters>
243.  
     <parameter name="tokens">COMMA</parameter>
244.  
     </parameters>
245.  
     </check>
246.  
      
247.  
     <!-- SPARK-3854: Single Space between ')' and '{' -->
248.  
     <check customId="SingleSpaceBetweenRParenAndLCurlyBrace" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
249.  
     <parameters><parameter name="regex">\)\{</parameter></parameters>
250.  
     <customMessage><![CDATA[
251.  
     Single Space between ')' and `{`.
252.  
     ]]></customMessage>
253.  
     </check>
254.  
      
255.  
     <check customId="NoScalaDoc" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
256.  
     <parameters><parameter name="regex">(?m)^(\s*)/[*][*].*$(\r|)\n^\1 [*]</parameter></parameters>
257.  
     <customMessage>Use Javadoc style indentation for multiline comments</customMessage>
258.  
     </check>
259.  
      
260.  
     <check customId="OmitBracesInCase" level="error" class="org.scalastyle.file.RegexChecker" enabled="true">
261.  
     <parameters><parameter name="regex">case[^\n>]*=>\s*\{</parameter></parameters>
262.  
     <customMessage>Omit braces in case clauses.</customMessage>
263.  
     </check>
264.  
      
265.  
     <!-- SPARK-16877: Avoid Java annotations -->
266.  
     <check level="error" class="org.scalastyle.scalariform.OverrideJavaChecker" enabled="true"></check>
267.  
      
268.  
     <check level="error" class="org.scalastyle.scalariform.DeprecatedJavaChecker" enabled="true"></check>
269.  
      
270.  
     <!-- ================================================================================ -->
271.  
     <!-- rules we'd like to enforce, but haven't cleaned up the codebase yet -->
272.  
     <!-- ================================================================================ -->
273.  
      
274.  
     <!-- We cannot turn the following two on, because it'd fail a lot of string interpolation use cases. -->
275.  
     <!-- Ideally the following two rules should be configurable to rule out string interpolation. -->
276.  
     <check level="error" class="org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker" enabled="false"></check>
277.  
     <check level="error" class="org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker" enabled="false"></check>
278.  
      
279.  
     <!-- This breaks symbolic method names so we don't turn it on. -->
280.  
     <!-- Maybe we should update it to allow basic symbolic names, and then we are good to go. -->
281.  
     <check level="error" class="org.scalastyle.scalariform.MethodNamesChecker" enabled="false">
282.  
     <parameters>
283.  
     <parameter name="regex"><![CDATA[^[a-z][A-Za-z0-9]*$]]></parameter>
284.  
     </parameters>
285.  
     </check>
286.  
      
287.  
     <!-- Should turn this on, but we have a few places that need to be fixed first -->
288.  
     <check level="error" class="org.scalastyle.scalariform.EqualsHashCodeChecker" enabled="true"></check>
289.  
      
290.  
     <!-- ================================================================================ -->
291.  
     <!-- rules we don't want -->
292.  
     <!-- ================================================================================ -->
293.  
      
294.  
     <check level="error" class="org.scalastyle.scalariform.IllegalImportsChecker" enabled="false">
295.  
     <parameters><parameter name="illegalImports"><![CDATA[sun._,java.awt._]]></parameter></parameters>
296.  
     </check>
297.  
      
298.  
     <!-- We want the opposite of this: NewLineAtEofChecker -->
299.  
     <check level="error" class="org.scalastyle.file.NoNewLineAtEofChecker" enabled="false"></check>
300.  
      
301.  
     <!-- This one complains about all kinds of random things. Disable. -->
302.  
     <check level="error" class="org.scalastyle.scalariform.SimplifyBooleanExpressionChecker" enabled="false"></check>
303.  
      
304.  
     <!-- We use return quite a bit for control flows and guards -->
305.  
     <check level="error" class="org.scalastyle.scalariform.ReturnChecker" enabled="false"></check>
306.  
      
307.  
     <!-- We use null a lot in low level code and to interface with 3rd party code -->
308.  
     <check level="error" class="org.scalastyle.scalariform.NullChecker" enabled="false"></check>
309.  
      
310.  
     <!-- Doesn't seem super big deal here ... -->
311.  
     <check level="error" class="org.scalastyle.scalariform.NoCloneChecker" enabled="false"></check>
312.  
      
313.  
     <!-- Doesn't seem super big deal here ... -->
314.  
     <check level="error" class="org.scalastyle.file.FileLengthChecker" enabled="false">
315.  
     <parameters><parameter name="maxFileLength">800></parameter></parameters>
316.  
     </check>
317.  
      
318.  
     <!-- Doesn't seem super big deal here ... -->
319.  
     <check level="error" class="org.scalastyle.scalariform.NumberOfTypesChecker" enabled="false">
320.  
     <parameters><parameter name="maxTypes">30</parameter></parameters>
321.  
     </check>
322.  
      
323.  
     <!-- Doesn't seem super big deal here ... -->
324.  
     <check level="error" class="org.scalastyle.scalariform.CyclomaticComplexityChecker" enabled="false">
325.  
     <parameters><parameter name="maximum">10</parameter></parameters>
326.  
     </check>
327.  
      
328.  
     <!-- Doesn't seem super big deal here ... -->
329.  
     <check level="error" class="org.scalastyle.scalariform.MethodLengthChecker" enabled="false">
330.  
     <parameters><parameter name="maxLength">50</parameter></parameters>
331.  
     </check>
332.  
      
333.  
     <!-- Not exactly feasible to enforce this right now. -->
334.  
     <!-- It is also infrequent that somebody introduces a new class with a lot of methods. -->
335.  
     <check level="error" class="org.scalastyle.scalariform.NumberOfMethodsInTypeChecker" enabled="false">
336.  
     <parameters><parameter name="maxMethods"><![CDATA[30]]></parameter></parameters>
337.  
     </check>
338.  
      
339.  
     <!-- Doesn't seem super big deal here, and we have a lot of magic numbers ... -->
340.  
     <check level="error" class="org.scalastyle.scalariform.MagicNumberChecker" enabled="false">
341.  
     <parameters><parameter name="ignore">-1,0,1,2,3</parameter></parameters>
342.  
     </check>
343.  
      
344.  
     </scalastyle>

 

---------------------
作者：心有余力
来源：优快云
原文：https://blog.youkuaiyun.com/lingeio/article/details/98388211
版权声明：本文为作者原创文章，转载请附上博文链接！
内容解析By：优快云,CNBLOG博客文章一键转载插件