Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Upgrade Checkstyle to 10.14.0 #463

Merged
merged 1 commit into from
Mar 24, 2024
Merged

Upgrade Checkstyle to 10.14.0 #463

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions ...eckstyle/src/main/java/org/openhab/tools/analysis/checkstyle/JavadocMethodStyleCheck.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
import com.puppycrawl.tools.checkstyle.api.FileContents;
import com.puppycrawl.tools.checkstyle.api.TextBlock;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.CheckUtil;
import com.puppycrawl.tools.checkstyle.checks.javadoc.MissingJavadocMethodCheck;
import com.puppycrawl.tools.checkstyle.utils.CommonUtil;

/**
Expand Down Expand Up @@ -123,8 +123,8 @@ public int[] getRequiredTokens() {

@Override
public void visitToken(DetailAST ast) {
boolean skipCheck = (CheckUtil.isSetterMethod(ast) || CheckUtil.isGetterMethod(ast))
&& allowMissingPropertyJavadoc;
boolean skipCheck = (MissingJavadocMethodCheck.isSetterMethod(ast)
|| MissingJavadocMethodCheck.isGetterMethod(ast)) && allowMissingPropertyJavadoc;
if (!skipCheck) {
visit(ast);
}
Expand Down
2 changes: 1 addition & 1 deletion docs/maven-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Parameters:
| ------ | ------| -------- |
| **checkstyleRuleset** | String | Relative path of the XML configuration to use. If not set the default ruleset file will be used |
| **checkstyleFilter** | String | Relative path of the suppressions XML file to use. If not set the default filter file will be used |
| **maven.checkstyle.version** | String | The version of the maven-checkstyle-plugin that will be used (default value is **3.1.2**)|
| **maven.checkstyle.version** | String | The version of the maven-checkstyle-plugin that will be used (default value is **3.3.1**)|
| **checkstylePlugins** | List<Dependency> | A list with artifacts that contain additional checks for Checkstyle |
| **checkstyleProperties** | String | Relative path of the properties file to use in the ruleset to configure specific checks |

Expand Down
2 changes: 1 addition & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@
<mockito.version>4.10.0</mockito.version>
<maven.resources.version>3.3.0</maven.resources.version>
<pmd.version>6.53.0</pmd.version>
<checkstyle.version>10.6.0</checkstyle.version>
<checkstyle.version>10.14.0</checkstyle.version>
<spotbugs.version>4.8.3</spotbugs.version>
<maven.core.version>3.6.0</maven.core.version>
<maven.plugin.api.version>3.8.5</maven.plugin.api.version>
Expand Down
4 changes: 2 additions & 2 deletions sat-plugin/src/main/java/org/openhab/tools/analysis/tools/CheckstyleChecker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ public class CheckstyleChecker extends AbstractChecker {
/**
* The version of the maven-checkstyle-plugin that will be used
*/
@Parameter(property = "maven.checkstyle.version", defaultValue = "3.2.1")
@Parameter(property = "maven.checkstyle.version", defaultValue = "3.3.1")
private String checkstyleMavenVersion;

/**
Expand Down Expand Up @@ -118,7 +118,7 @@ public void execute() throws MojoExecutionException {

checkstylePlugins.add(dependency("org.openhab.tools.sat.custom-checks", "checkstyle", plugin.getVersion()));
// Maven may load an older version, if no version is specified
checkstylePlugins.add(dependency("com.puppycrawl.tools", "checkstyle", "10.6.0"));
checkstylePlugins.add(dependency("com.puppycrawl.tools", "checkstyle", "10.14.0"));
checkstylePlugins.forEach(logDependency());

String baseDir = mavenProject.getBasedir().toString();
Expand Down