Issue #213: update to CS 8.20

checkstyle · Apr 30, 2019 · 388ed37 · 388ed37
1 parent ffe9a56
commit 388ed37
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@ Compatibility matrix from checkstyle team:
 
 Checkstyle Plugin|Sonar min|Sonar max|Checkstyle|Jdk
 -----------------|---------|---------|----------|---
+4.20|6.7  |7.7+|8.20|1.8
 4.19|6.7  |7.7+|8.19|1.8
 4.18|6.7  |7.7+|8.18|1.8
 4.17|6.7  |7.5|8.17|1.8

diff --git a/pom.xml b/pom.xml
@@ -81,7 +81,7 @@
   </ciManagement>
 
   <properties>
-    <checkstyle.version>8.19</checkstyle.version>
+    <checkstyle.version>8.20</checkstyle.version>
     <sonar.version>6.7</sonar.version>
     <sonar-java.version>5.12.0.17701</sonar-java.version>
     <maven.checkstyle.plugin.version>2.17</maven.checkstyle.plugin.version>

diff --git a/src/main/resources/com/sonar/sqale/checkstyle-model.xml b/src/main/resources/com/sonar/sqale/checkstyle-model.xml
@@ -894,6 +894,19 @@
           <txt>min</txt>
         </prop>
       </chc>
+      <chc>
+        <rule-repo>checkstyle</rule-repo>
+        <rule-key>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck</rule-key>
+        <prop>
+          <key>remediationFunction</key>
+          <txt>CONSTANT_ISSUE</txt>
+        </prop>
+        <prop>
+          <key>offset</key>
+          <val>10</val>
+          <txt>min</txt>
+        </prop>
+      </chc>
       <chc>
         <rule-repo>checkstyle</rule-repo>
         <rule-key>com.puppycrawl.tools.checkstyle.checks.design.FinalClassCheck</rule-key>

diff --git a/src/main/resources/org/sonar/l10n/checkstyle.properties b/src/main/resources/org/sonar/l10n/checkstyle.properties
@@ -114,6 +114,11 @@ rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCh
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.param.scope=visibility scope where Javadoc comments are checked
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.param.ignoreNamePattern=regexp to define variable names to ignore
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.param.tokens=tokens to check
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck.name=Missing Javadoc Type
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck.param.excludeScope=visibility scope where Javadoc comments are not checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck.param.scope=visibility scope where Javadoc comments are checked
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck.param.skipAnnotations=specify the list of annotations that allow missed documentation. Only short names are allowed, e.g. Generated
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck.param.tokens=tokens to check
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck.name=Illegal Instantiation
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck.param.classes=classes that should not be instantiated
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.IllegalInstantiationCheck.param.tokens=tokens to check

diff --git a/...es/checkstyle/com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck.html b/...es/checkstyle/com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck.html
@@ -0,0 +1 @@
+Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions. The scope to verify is specified using the Scope class and defaults to Scope.PUBLIC. To verify another scope, set property scope to one of the Scope constants.
diff --git a/src/main/resources/org/sonar/plugins/checkstyle/rules.xml b/src/main/resources/org/sonar/plugins/checkstyle/rules.xml
@@ -938,6 +938,24 @@
     <status>READY</status>
   </rule>
 
+  <rule key="com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocTypeCheck">
+    <priority>MAJOR</priority>
+    <name><![CDATA[Missing Javadoc Type]]></name>
+    <configKey><![CDATA[Checker/TreeWalker/MissingJavadocType]]></configKey>
+    <cardinality>MULTIPLE</cardinality>
+    <param key="scope" type="s[nothing,public,protected,package,private,anoninner]">
+      <defaultValue>public</defaultValue>
+    </param>
+    <param key="excludeScope" type="s[nothing,public,protected,package,private,anoninner]">
+    </param>
+    <param key="skipAnnotations" type="s{}">
+    </param>
+    <param key="tokens" type="s[INTERFACE_DEF,CLASS_DEF,ENUM_DEF,ANNOTATION_DEF]">
+      <defaultValue>INTERFACE_DEF,CLASS_DEF,ENUM_DEF,ANNOTATION_DEF</defaultValue>
+    </param>
+    <status>READY</status>
+  </rule>
+
   <rule key="com.puppycrawl.tools.checkstyle.checks.blocks.LeftCurlyCheck">
     <priority>MINOR</priority>
     <name><![CDATA[Left Curly]]></name>

diff --git a/src/test/java/org/sonar/plugins/checkstyle/CheckstyleRulesDefinitionTest.java b/src/test/java/org/sonar/plugins/checkstyle/CheckstyleRulesDefinitionTest.java
@@ -61,7 +61,7 @@ public void test() {
         assertThat(repository.language()).isEqualTo("java");
 
         final List<RulesDefinition.Rule> rules = repository.rules();
-        assertThat(rules).hasSize(157);
+        assertThat(rules).hasSize(158);
 
         for (RulesDefinition.Rule rule : rules) {
             assertThat(rule.key()).isNotNull();
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Checks for missing Javadoc comments for class, enum, interface, and annotation interface definitions. The scope to verify is specified using the Scope class and defaults to Scope.PUBLIC. To verify another scope, set property scope to one of the Scope constants.