Skip to content

Commit e0d4eab

Browse files
Daniel Muehlbachlerromani
authored andcommitted
Issue #292: update to CS 8.32
1 parent 343c1a7 commit e0d4eab

File tree

7 files changed

+36
-4
lines changed

7 files changed

+36
-4
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Compatibility matrix from checkstyle team:
2121

2222
Checkstyle Plugin|Sonar min|Sonar max|Checkstyle|Jdk
2323
-----------------|---------|---------|----------|---
24+
4.32|7.9 |7.9+|8.32|1.8
2425
4.31|7.9 |7.9+|8.31|1.8
2526
4.30|7.9 |7.9+|8.30|1.8
2627
4.29|7.9 |7.9+|8.29|1.8

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@
9393
</ciManagement>
9494

9595
<properties>
96-
<checkstyle.version>8.31</checkstyle.version>
96+
<checkstyle.version>8.32</checkstyle.version>
9797
<sonar.version>7.9</sonar.version>
9898
<sonar-java.version>6.0.0.20538</sonar-java.version>
9999
<maven.checkstyle.plugin.version>3.1.0</maven.checkstyle.plugin.version>

src/main/resources/com/sonar/sqale/checkstyle-model.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,6 +1076,19 @@
10761076
<txt>min</txt>
10771077
</prop>
10781078
</chc>
1079+
<chc>
1080+
<rule-repo>checkstyle</rule-repo>
1081+
<rule-key>com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck</rule-key>
1082+
<prop>
1083+
<key>remediationFunction</key>
1084+
<txt>CONSTANT_ISSUE</txt>
1085+
</prop>
1086+
<prop>
1087+
<key>offset</key>
1088+
<val>30</val>
1089+
<txt>min</txt>
1090+
</prop>
1091+
</chc>
10791092
<chc>
10801093
<rule-repo>checkstyle</rule-repo>
10811094
<rule-key>com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck</rule-key>

src/main/resources/org/sonar/l10n/checkstyle.properties

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLoc
9797
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck.param.location=Specify the policy on placement of the Javadoc content
9898
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck.name=Javadoc Block Tag Location
9999
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocBlockTagLocationCheck.param.tags=Specify the javadoc tags to process.
100+
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck.name=Javadoc Missing Whitespace After Asterisk
100101
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck.name=Missing Javadoc Method
101102
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck.param.tokens=definitions to check
102103
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck.param.scope=visibility scope where Javadoc comments are checked
@@ -479,6 +480,7 @@ rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWord
479480
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck.param.allowedAbbreviations=list of abbreviations that must be skipped for checking. Abbreviations should be separated by comma, no spaces are allowed.
480481
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck.param.ignoreFinal=allow to skip variables with final modifier.
481482
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck.param.ignoreStatic=allow to skip variables with static modifier.
483+
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck.param.ignoreStaticFinal=Allow to skip variables with both static and final modifiers.
482484
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck.param.ignoreOverriddenMethods=Allows to ignore methods tagged with @Override annotation (that usually mean inherited name).
483485
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck.param.tokens=tokens to check
484486
rule.checkstyle.com.puppycrawl.tools.checkstyle.checks.AvoidEscapedUnicodeCharactersCheck.name=Avoid Escaped Unicode Characters
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<p>
2+
Checks that there is at least one whitespace after the leading asterisk. Although spaces after asterisks are
3+
optional in the Javadoc comments, their absence makes the documentation difficult to read. It is the de facto
4+
standard to put at least one whitespace after the leading asterisk.
5+
</p>

src/main/resources/org/sonar/plugins/checkstyle/rules.xml

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -868,6 +868,14 @@
868868
<status>READY</status>
869869
</rule>
870870

871+
<rule key="com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck">
872+
<priority>MAJOR</priority>
873+
<name><![CDATA[Javadoc Missing Whitespace After Asterisk]]></name>
874+
<tag>comment</tag>
875+
<configKey><![CDATA[Checker/TreeWalker/JavadocMissingWhitespaceAfterAsterisk]]></configKey>
876+
<status>READY</status>
877+
</rule>
878+
871879
<rule key="com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck">
872880
<priority>MAJOR</priority>
873881
<name><![CDATA[Missing Javadoc Method]]></name>
@@ -1339,8 +1347,8 @@
13391347
<param key="allowLineBreaks" type="BOOLEAN">
13401348
<defaultValue>false</defaultValue>
13411349
</param>
1342-
<param key="tokens" type="s[COMMA,SEMI,POST_INC,POST_DEC,DOT,GENERIC_START,GENERIC_END,ELLIPSIS,METHOD_REF]">
1343-
<defaultValue>COMMA,SEMI,POST_INC,POST_DEC,ELLIPSIS</defaultValue>
1350+
<param key="tokens" type="s[COMMA,SEMI,POST_INC,POST_DEC,DOT,GENERIC_START,GENERIC_END,ELLIPSIS,LABELED_STAT,METHOD_REF]">
1351+
<defaultValue>COMMA,SEMI,POST_INC,POST_DEC,ELLIPSIS,LABELED_STAT</defaultValue>
13441352
</param>
13451353
</rule>
13461354

@@ -1910,6 +1918,9 @@
19101918
<param key="ignoreStatic" type="BOOLEAN">
19111919
<defaultValue>true</defaultValue>
19121920
</param>
1921+
<param key="ignoreStaticFinal" type="BOOLEAN">
1922+
<defaultValue>true</defaultValue>
1923+
</param>
19131924
<param key="ignoreOverriddenMethods" type="BOOLEAN">
19141925
<defaultValue>true</defaultValue>
19151926
</param>

src/test/java/org/sonar/plugins/checkstyle/CheckstyleRulesDefinitionTest.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ public void test() {
6161
assertThat(repository.language()).isEqualTo("java");
6262

6363
final List<RulesDefinition.Rule> rules = repository.rules();
64-
assertThat(rules).hasSize(172);
64+
assertThat(rules).hasSize(173);
6565

6666
for (RulesDefinition.Rule rule : rules) {
6767
assertThat(rule.key()).isNotNull();

0 commit comments

Comments
 (0)