Issue checkstyle#231: update to CS 8.22

muhlba91 · Sep 10, 2019 · 3720bde · 3720bde
1 parent 1f56ee9
commit 3720bde
Show file tree

Hide file tree

Showing 10 changed files with 121 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.22|6.7  |7.7+|8.22|1.8
 4.21|6.7  |7.7+|8.21|1.8
 4.20|6.7  |7.7+|8.20|1.8
 4.19|6.7  |7.7+|8.19|1.8

diff --git a/pom.xml b/pom.xml
@@ -81,7 +81,7 @@
   </ciManagement>
 
   <properties>
-    <checkstyle.version>8.21</checkstyle.version>
+    <checkstyle.version>8.22</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
@@ -1193,6 +1193,19 @@
           <txt>min</txt>
         </prop>
       </chc>
+      <chc>
+        <rule-repo>checkstyle</rule-repo>
+        <rule-key>com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck</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.metrics.BooleanExpressionComplexityCheck</rule-key>
@@ -1297,6 +1310,32 @@
           <txt>min</txt>
         </prop>
       </chc>
+      <chc>
+        <rule-repo>checkstyle</rule-repo>
+        <rule-key>com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck</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.coding.UnnecessarySemicolonInEnumerationCheck</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.javadoc.JavadocPackageCheck</rule-key>
@@ -1310,6 +1349,19 @@
           <txt>min</txt>
         </prop>
       </chc>
+      <chc>
+        <rule-repo>checkstyle</rule-repo>
+        <rule-key>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck</rule-key>
+        <prop>
+          <key>remediationFunction</key>
+          <txt>CONSTANT_ISSUE</txt>
+        </prop>
+        <prop>
+          <key>offset</key>
+          <val>30</val>
+          <txt>min</txt>
+        </prop>
+      </chc>
       <chc>
         <rule-repo>checkstyle</rule-repo>
         <rule-key>com.puppycrawl.tools.checkstyle.checks.imports.CustomImportOrderCheck</rule-key>

diff --git a/src/main/resources/org/sonar/l10n/checkstyle.properties b/src/main/resources/org/sonar/l10n/checkstyle.properties
@@ -7,6 +7,7 @@ rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.EqualsAvoidNullChe
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck.name=Javadoc Package
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck.param.allowLegacy=If set then allow the use of a package.html file.
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck.param.fileExtensions=file type extension of files to process
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck.name=Missing Javadoc Package
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.name=Declaration Order
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.param.ignoreModifiers=Whether to ignore modifiers
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.param.ignoreConstructors=Whether to ignore constructors
@@ -448,6 +449,8 @@ rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.GenericWhitesp
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NoCloneCheck.name=No Clone
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.InnerTypeLastCheck.name=Inner Type Last
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.OuterTypeFilenameCheck.name=Outer Type Filename
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck.name=Ordered Properties
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck.param.fileExtensions=Specify file type extension of the files to check.
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck.name=Nested For Depth
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck.param.max=allowed nesting depth.
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.sizes.MethodCountCheck.name=Method Count
@@ -494,6 +497,9 @@ rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapChec
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapCheck.param.tokens=assignments to check
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.design.OneTopLevelClassCheck.name=One Top Level Class
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.OverloadMethodsDeclarationOrderCheck.name=Overload Methods Declaration Order
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck.name=Unnecessary Semicolon in Enumeration
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck.name=Unnecessary Semicolon in Resource Declaration
+rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck.param.allowWhenNoBraceAfterSemicolon=Allow unnecessary semicolon if closing paren is not on the same line.
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck.name=Variable Declaration Usage Distance
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck.param.allowedDistance=A distance between declaration of variable and its first usage
 rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck.param.ignoreVariablePattern=pattern for ignoring the distance calculation

diff --git a/...style/rules/checkstyle/com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck.html b/...style/rules/checkstyle/com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck.html
@@ -0,0 +1,13 @@
+<p>
+    Detects if keys in properties files are in correct order.
+    <br>
+    Rationale: Sorted properties make it easy for people to find required properties by name in file. It makes merges
+    more easy. While there are no problems at runtime. This check is valuable only on files with string resources where
+    order of lines does not matter at all, but this can be improved. E.g.:
+    checkstyle/src/main/resources/com/puppycrawl/tools/checkstyle/messages.properties You may suppress warnings of this
+    check for files that have an logical structure like build files or log4j configuration files. See SuppressionFilter.
+    &lt;suppress checks="OrderedProperties" files="log4j.properties|ResourceBundle/Bug.*.properties|logging.properties"/&gt;
+    <br>
+    Known limitation: The key should not contain a newline. The string compare will work, but not the line number
+    reporting.
+</p>
diff --git a/...com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck.html b/...com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck.html
@@ -0,0 +1,4 @@
+<p>
+    Checks if unnecessary semicolon is in enum definitions. Semicolon is not needed if enum body contains only enum
+    constants.
+</p>
diff --git a/...uppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck.html b/...uppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck.html
@@ -0,0 +1,3 @@
+<p>
+    Checks if unnecessary semicolon is used in last resource declaration.
+</p>
diff --git a/...checkstyle/com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck.html b/...checkstyle/com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck.html
@@ -0,0 +1,8 @@
+<p>
+    Checks for missing Javadoc comments in package-info.java files.
+    <br>
+    Rationale: description and other related documentation for a package can be written up in the package-info.java file
+    and it gets used in the production of the Javadocs. See <a
+        href="https://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#packagecomment">link</a> for
+    more info.
+</p>
diff --git a/src/main/resources/org/sonar/plugins/checkstyle/rules.xml b/src/main/resources/org/sonar/plugins/checkstyle/rules.xml
@@ -128,6 +128,14 @@
     <status>READY</status>
   </rule>
 
+  <rule key="com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocPackageCheck">
+    <priority>MINOR</priority>
+    <name><![CDATA[Missing Javadoc Package]]></name>
+    <tag>comment</tag>
+    <configKey><![CDATA[Checker/TreeWalker/MissingJavadocPackage]]></configKey>
+    <status>READY</status>
+  </rule>
+
   <rule key="com.puppycrawl.tools.checkstyle.checks.regexp.RegexpMultilineCheck">
     <priority>MAJOR</priority>
     <name><![CDATA[Regexp Multiline]]></name>
@@ -1755,6 +1763,15 @@
     <configKey><![CDATA[Checker/TreeWalker/OuterTypeFilename]]></configKey>
   </rule>
 
+  <rule key="com.puppycrawl.tools.checkstyle.checks.OrderedPropertiesCheck">
+    <priority>MAJOR</priority>
+    <name><![CDATA[Ordered Properties]]></name>
+    <configKey><![CDATA[Checker/OrderedProperties]]></configKey>
+    <param key="fileExtensions" type="s{}">
+      <defaultValue>properties</defaultValue>
+    </param>
+  </rule>
+
   <rule key="com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck">
     <priority>MAJOR</priority>
     <name><![CDATA[Nested For Depth]]></name>
@@ -1960,6 +1977,21 @@
     </param>
   </rule>
 
+  <rule key="com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInTryWithResourcesCheck">
+    <name><![CDATA[Unnecessary Semicolon in Resource Definition]]></name>
+    <priority>MAJOR</priority>
+    <configKey><![CDATA[Checker/TreeWalker/UnnecessarySemicolonInTryWithResources]]></configKey>
+    <param key="allowWhenNoBraceAfterSemicolon" type="BOOLEAN">
+      <defaultValue>true</defaultValue>
+    </param>
+  </rule>
+
+  <rule key="com.puppycrawl.tools.checkstyle.checks.coding.UnnecessarySemicolonInEnumerationCheck">
+    <name><![CDATA[Unnecessary Semicolon in Enumeration]]></name>
+    <priority>MAJOR</priority>
+    <configKey><![CDATA[Checker/TreeWalker/UnnecessarySemicolonInEnumeration]]></configKey>
+  </rule>
+
   <rule key="com.puppycrawl.tools.checkstyle.checks.annotation.AnnotationLocationCheck">
     <name><![CDATA[Annotation Location]]></name>
     <priority>MAJOR</priority>

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(159);
+        assertThat(rules).hasSize(163);
 
         for (RulesDefinition.Rule rule : rules) {
             assertThat(rule.key()).isNotNull();