Add more scalastyle runes & configure codacy

sbt · Oct 2, 2017 · 515ef6d · 515ef6d
1 parent 9b0a351
commit 515ef6d
Show file tree

Hide file tree

Showing 5 changed files with 85 additions and 45 deletions.
diff --git a/.codacy.yml b/.codacy.yml
@@ -0,0 +1,3 @@
+---
+exclude_paths:
+  - src/sbt-test/**
diff --git a/README.md b/README.md
@@ -1,6 +1,7 @@
 # sbt-findbugs - Static code analysis via FindBugs from within sbt
 
 [![Build Status](https://travis-ci.org/sbt/sbt-findbugs.svg?branch=master)](https://travis-ci.org/sbt/sbt-findbugs)
+[![Codacy Grade](https://img.shields.io/codacy/grade/c5bcab37c4a04974b06a1cfd3f5a9fcc.svg?label=codacy)](https://www.codacy.com/app/stringbean/sbt-findbugs)
 [![SBT 0.13 version](https://img.shields.io/badge/sbt_0.13-2.0.0-blue.svg)](https://bintray.com/stringbean/sbt-plugins/sbt-findbugs)
 [![SBT 1.0 version](https://img.shields.io/badge/sbt_1.0-2.0.0-blue.svg)](https://bintray.com/stringbean/sbt-plugins/sbt-findbugs)
 

diff --git a/build.sbt b/build.sbt
@@ -1,7 +1,7 @@
 name := "sbt-findbugs"
 organization := "com.github.sbt"
 
-version := "2.0.0"
+version := "2.0.1-SNAPSHOT"
 
 sbtPlugin := true
 crossSbtVersions := Seq("0.13.16", "1.0.2")

diff --git a/scalastyle-config.xml b/scalastyle-config.xml
@@ -1,91 +1,127 @@
 <scalastyle>
-    <name>Scalastyle standard configuration</name>
+    <!-- whitespace/file format =========================================== -->
     <check level="warning" class="org.scalastyle.file.FileTabChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.file.FileLengthChecker" enabled="true">
-        <parameters>
-            <parameter name="maxFileLength"><![CDATA[800]]></parameter>
-        </parameters>
-    </check>
-    <check level="warning" class="org.scalastyle.scalariform.SpacesAfterPlusChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.file.NewLineAtEofChecker" enabled="true"/>
     <check level="warning" class="org.scalastyle.file.WhitespaceEndOfLineChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.scalariform.SpacesBeforePlusChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.file.FileLineLengthChecker" enabled="true">
+
+    <!-- naming =========================================================== -->
+    <check level="warning" class="org.scalastyle.scalariform.ClassNamesChecker" enabled="true">
         <parameters>
-            <parameter name="maxLineLength"><![CDATA[120]]></parameter>
+            <parameter name="regex">^[A-Z][A-Za-z]*$</parameter>
         </parameters>
     </check>
-    <check level="warning" class="org.scalastyle.scalariform.ClassNamesChecker" enabled="true">
+    <check level="warning" class="org.scalastyle.scalariform.MethodNamesChecker" enabled="true">
         <parameters>
-            <parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
+            <parameter name="regex">^[a-z][A-Za-z0-9]*$</parameter>
         </parameters>
     </check>
     <check level="warning" class="org.scalastyle.scalariform.ObjectNamesChecker" enabled="true">
         <parameters>
-            <parameter name="regex"><![CDATA[[A-Z][A-Za-z]*]]></parameter>
+            <parameter name="regex">^[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>
+            <parameter name="regex">^[a-z][A-Za-z]*$</parameter>
         </parameters>
     </check>
-    <check level="warning" class="org.scalastyle.scalariform.EqualsHashCodeChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.scalariform.IllegalImportsChecker" enabled="true">
+
+    <!-- complexity/size ================================================== -->
+    <check level="warning" class="org.scalastyle.file.FileLengthChecker" enabled="true">
         <parameters>
-            <parameter name="illegalImports"><![CDATA[sun._,java.awt._]]></parameter>
+            <parameter name="maxFileLength">200</parameter>
         </parameters>
     </check>
-    <check level="warning" class="org.scalastyle.scalariform.ParameterNumberChecker" enabled="true">
+    <check level="warning" class="org.scalastyle.file.FileLineLengthChecker" enabled="true">
         <parameters>
-            <parameter name="maxParameters"><![CDATA[8]]></parameter>
+            <parameter name="maxLineLength">120</parameter>
         </parameters>
     </check>
-    <check level="warning" class="org.scalastyle.scalariform.MagicNumberChecker" enabled="true">
+
+    <check level="warning" class="org.scalastyle.scalariform.MethodLengthChecker" enabled="true">
         <parameters>
-            <parameter name="ignore"><![CDATA[-1,0,1,2,3]]></parameter>
+            <parameter name="maxLength">50</parameter>
         </parameters>
     </check>
-    <check level="warning" class="org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.scalariform.ReturnChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.scalariform.NoCloneChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.scalariform.NoFinalizeChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.scalariform.CovariantEqualsChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.scalariform.StructuralTypeChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.file.RegexChecker" enabled="true">
+    <check level="warning" class="org.scalastyle.scalariform.NumberOfMethodsInTypeChecker" enabled="true">
         <parameters>
-            <parameter name="regex"><![CDATA[println]]></parameter>
+            <parameter name="maxMethods">15</parameter>
         </parameters>
     </check>
     <check level="warning" class="org.scalastyle.scalariform.NumberOfTypesChecker" enabled="true">
         <parameters>
-            <parameter name="maxTypes"><![CDATA[30]]></parameter>
+            <parameter name="maxTypes">10</parameter>
         </parameters>
     </check>
-    <check level="warning" class="org.scalastyle.scalariform.UppercaseLChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.scalariform.SimplifyBooleanExpressionChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.ParameterNumberChecker" enabled="true">
+        <parameters>
+            <parameter name="maxParameters">8</parameter>
+        </parameters>
+    </check>
+
+    <!-- formatting ======================================================= -->
+    <check enabled="true" class="org.scalastyle.scalariform.EmptyClassChecker" level="warning"/>
+    <check enabled="true" class="org.scalastyle.scalariform.ForBraceChecker" level="warning"/>
+
     <check level="warning" class="org.scalastyle.scalariform.IfBraceChecker" enabled="true">
         <parameters>
-            <parameter name="singleLineAllowed"><![CDATA[true]]></parameter>
-            <parameter name="doubleLineAllowed"><![CDATA[false]]></parameter>
+            <parameter name="singleLineAllowed">true</parameter>
+            <parameter name="doubleLineAllowed">false</parameter>
         </parameters>
     </check>
-    <check level="warning" class="org.scalastyle.scalariform.MethodLengthChecker" enabled="true">
+
+    <check level="warning" class="org.scalastyle.scalariform.ImportGroupingChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.ImportOrderChecker" enabled="true">
         <parameters>
-            <parameter name="maxLength"><![CDATA[50]]></parameter>
+            <parameter name="groups">java,scala,sbt,others</parameter>
+            <parameter name="group.java">javax?\..+</parameter>
+            <parameter name="group.scala">scala\..+</parameter>
+            <parameter name="group.scala">sbt\..+</parameter>
+            <parameter name="group.others">.+</parameter>
         </parameters>
     </check>
-    <check level="warning" class="org.scalastyle.scalariform.MethodNamesChecker" enabled="true">
+
+    <check level="warning" class="org.scalastyle.scalariform.NoWhitespaceBeforeLeftBracketChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.NoWhitespaceAfterLeftBracketChecker" enabled="true"/>
+
+    <check level="warning" class="org.scalastyle.scalariform.SpacesAfterPlusChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.SpacesBeforePlusChecker" enabled="true"/>
+
+    <check level="warning" class="org.scalastyle.scalariform.UppercaseLChecker" enabled="true"/>
+
+    <!-- code smells ====================================================== -->
+
+    <check level="warning" class="org.scalastyle.scalariform.CovariantEqualsChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.EqualsHashCodeChecker" enabled="true"/>
+
+    <check level="warning" class="org.scalastyle.scalariform.IllegalImportsChecker" enabled="true">
         <parameters>
-            <parameter name="regex"><![CDATA[^[a-z][A-Za-z0-9]*$]]></parameter>
+            <parameter name="illegalImports">sun._,java.awt._></parameter>
         </parameters>
     </check>
-    <check level="warning" class="org.scalastyle.scalariform.NumberOfMethodsInTypeChecker" enabled="true">
+
+    <check level="warning" class="org.scalastyle.scalariform.MagicNumberChecker" enabled="true">
         <parameters>
-            <parameter name="maxMethods"><![CDATA[30]]></parameter>
+            <parameter name="ignore">-1,0,1,2,3</parameter>
         </parameters>
     </check>
+
+    <check level="warning" class="org.scalastyle.scalariform.NoCloneChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.NoFinalizeChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.NotImplementedErrorUsage" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.NullChecker" enabled="true"/>
     <check level="warning" class="org.scalastyle.scalariform.PublicMethodsHaveTypeChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.file.NewLineAtEofChecker" enabled="true"/>
-    <check level="warning" class="org.scalastyle.file.NoNewLineAtEofChecker" enabled="false"/>
+    <check level="warning" class="org.scalastyle.scalariform.RedundantIfChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.ReturnChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.SimplifyBooleanExpressionChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.StructuralTypeChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.VarFieldChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.VarLocalChecker" enabled="true"/>
+    <check level="warning" class="org.scalastyle.scalariform.WhileChecker" enabled="true"/>
+
+    <check level="warning" class="org.scalastyle.file.RegexChecker" enabled="true">
+        <parameters>
+            <parameter name="regex">println</parameter>
+        </parameters>
+    </check>
 </scalastyle>
diff --git a/src/main/scala/com/github/sbt/findbugs/FindbugsPlugin.scala b/src/main/scala/com/github/sbt/findbugs/FindbugsPlugin.scala
@@ -20,7 +20,7 @@ object FindbugsPlugin extends AutoPlugin {
 
   object autoImport extends FindbugsKeys
 
-  import autoImport._
+  import autoImport._ // scalastyle:ignore import.grouping
 
   override def requires: Plugins = JvmPlugin
   override def trigger: PluginTrigger = allRequirements