Issue sevntu-checkstyle#734: Remove some paranoia checks not covered …

…in the tests
mbert · May 15, 2019 · 143e2d7 · 143e2d7
1 parent bf9a578
commit 143e2d7
Show file tree

Hide file tree

Showing 19 changed files with 188 additions and 554 deletions.
diff --git a/...vntu-plugin/src/com/github/sevntu/checkstyle/checks/coding/checkstyle-metadata.properties b/...vntu-plugin/src/com/github/sevntu/checkstyle/checks/coding/checkstyle-metadata.properties
@@ -191,7 +191,7 @@ RequireFailForTryCatchInJunitCheck.desc = Checks if a try/catch block has a juni
 
 Jsr305AnnotationsCheck.name=Jsr305AnnotationsCheck
 Jsr305AnnotationsCheck.desc=Checks method parameters and return values for the presence of @Nonnull, @Nullable, or @CheckForNull annotations.
-Jsr305AnnotationsCheck.packages=Packages to be checked.
-Jsr305AnnotationsCheck.excludePackages=Packages excluded from checking.
+Jsr305AnnotationsCheck.packages=Sets the parent package for all classes that will be checked.
+Jsr305AnnotationsCheck.excludePackages=Packages excluded from checking. This can be useful if under the parent package set with "packages" there are subpackages which should not be checked.
 Jsr305AnnotationsCheck.allowOverridingReturnValue=Allow Overriding return values, useful for upgrading.
-Jsr305AnnotationsCheck.allowOverridingParameter=Allow Overriding paramaters, useful for upgrading.
+Jsr305AnnotationsCheck.allowOverridingParameter=Allow Overriding parameters, useful for upgrading.
diff --git a/sevntu-checks/pom.xml b/sevntu-checks/pom.xml
@@ -49,7 +49,7 @@
     <dependency>
       <groupId>com.google.code.findbugs</groupId>
       <artifactId>jsr305</artifactId>
-      <version>3.0.1</version>
+      <version>3.0.2</version>
     </dependency>
     <dependency>
       <groupId>com.google.code.findbugs</groupId>
@@ -294,8 +294,8 @@
               <regex><pattern>.*.checks.coding.MapIterationInForEachLoopCheck</pattern><branchRate>90</branchRate><lineRate>98</lineRate></regex>
               <regex><pattern>.*.checks.coding.NoNullForCollectionReturnCheck</pattern><branchRate>85</branchRate><lineRate>96</lineRate></regex>
               <regex><pattern>.*.checks.coding.OverridableMethodInConstructorCheck</pattern><branchRate>94</branchRate><lineRate>99</lineRate></regex>
-              <regex><pattern>.*.checks.coding.Jsr305AnnotationsCheck</pattern><branchRate>84</branchRate><lineRate>93</lineRate></regex>
-              <regex><pattern>.*.checks.coding.Jsr305AnnotationsCheck.AbstractJsr305Check</pattern><branchRate>95</branchRate><lineRate>98</lineRate></regex>
+              <regex><pattern>.*.checks.coding.Jsr305AnnotationsCheck</pattern><branchRate>97</branchRate><lineRate>100</lineRate></regex>
+              <regex><pattern>.*.checks.coding.Jsr305AnnotationsCheck.AbstractJsr305Check</pattern><branchRate>99</branchRate><lineRate>100</lineRate></regex>
               <regex><pattern>.*.checks.design.HideUtilityClassConstructorCheck</pattern><branchRate>94</branchRate><lineRate>100</lineRate></regex>
             </regexes>
           </check>

diff --git a/sevntu-checks/sevntu-checks.xml b/sevntu-checks/sevntu-checks.xml
@@ -159,6 +159,14 @@
     <module name="com.github.sevntu.checkstyle.checks.coding.WhitespaceBeforeArrayInitializerCheck"/>
     <module name="com.github.sevntu.checkstyle.checks.coding.MoveVariableInsideIfCheck" />
     <module name="com.github.sevntu.checkstyle.checks.coding.RequireFailForTryCatchInJunitCheck" />
+    <module name="com.github.sevntu.checkstyle.checks.coding.Jsr305AnnotationsCheck">
+      <property name="severity" value="ignore"/>
+      <property name="packages" value="com.github.sevntu.checkstyle.checks.naming,com.github.sevntu.checkstyle.checks.coding"/>
+      <property name="excludePackages" value="com.github.sevntu.checkstyle.checks.sizes,com.github.sevntu.checkstyle.checks.design"/>
+      <property name="allowOverridingReturnValue" value="false"/>
+      <property name="allowOverridingParameter" value="false"/>
+    </module>
+
 
     <!-- Design -->
     <module name="com.github.sevntu.checkstyle.checks.design.ChildBlockLengthCheck">
@@ -216,14 +224,6 @@
       <property name="ignoreMethod" value="false"/>
     </module>
 
-    <!-- Jsr305 -->
-    <module name="com.github.sevntu.checkstyle.checks.coding.Jsr305AnnotationsCheck">
-      <property name="packages" value="your.package.path.to.check,another.package.path.to.check"/>
-      <property name="excludePackages" value="your.package.path.not.to.check,another.package.path.not.to.check"/>
-      <property name="allowOverridingReturnValue" value="false"/>
-      <property name="allowOverridingParameter" value="false"/>
-    </module>
-
     <!-- moved to checkstyle project since 1.21.0 -->
     <!--
         <module name="com.github.sevntu.checkstyle.checks.whitespace.SingleSpaceSeparatorCheck">