-
Notifications
You must be signed in to change notification settings - Fork 2
Issue #36: Updated CheckstyleAutoFix to load checkstyle-config. #39
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
src/main/java/org/checkstyle/autofix/parser/CheckConfiguration.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,91 @@ | ||
/////////////////////////////////////////////////////////////////////////////////////////////// | ||
// checkstyle-openrewrite-recipes: Automatically fix Checkstyle violations with OpenRewrite. | ||
// Copyright (C) 2025 The Checkstyle OpenRewrite Recipes Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
/////////////////////////////////////////////////////////////////////////////////////////////// | ||
|
||
package org.checkstyle.autofix.parser; | ||
|
||
import java.util.List; | ||
import java.util.Map; | ||
|
||
public final class CheckConfiguration { | ||
private final String name; | ||
private final Map<String, String> properties; | ||
private final List<CheckConfiguration> children; | ||
private CheckConfiguration parent; | ||
|
||
public CheckConfiguration(String name, | ||
Map<String, String> properties, List<CheckConfiguration> children) { | ||
this.name = name; | ||
this.properties = properties; | ||
this.children = children; | ||
|
||
for (CheckConfiguration child : children) { | ||
child.setParent(this); | ||
} | ||
} | ||
|
||
public String getName() { | ||
return name; | ||
} | ||
|
||
public Map<String, String> getProperties() { | ||
return properties; | ||
} | ||
|
||
public List<CheckConfiguration> getChildren() { | ||
return children; | ||
} | ||
|
||
public String getProperty(String key) { | ||
return properties.get(key); | ||
} | ||
|
||
public int[] getIntArray(String propertyName) { | ||
final String value = properties.get(propertyName); | ||
final int[] result; | ||
final String[] parts = value.split(","); | ||
result = new int[parts.length]; | ||
for (int index = 0; index < parts.length; index++) { | ||
try { | ||
result[index] = Integer.parseInt(parts[index].trim()); | ||
} | ||
catch (NumberFormatException exception) { | ||
throw new IllegalArgumentException("Property '" + propertyName | ||
+ "' has an invalid integer value: " + parts[index].trim(), exception); | ||
} | ||
} | ||
return result; | ||
} | ||
|
||
public CheckConfiguration getChild(String childName) { | ||
CheckConfiguration result = null; | ||
for (CheckConfiguration child : children) { | ||
if (childName.equals(child.getName())) { | ||
result = child; | ||
break; | ||
} | ||
} | ||
return result; | ||
} | ||
|
||
public CheckConfiguration getParent() { | ||
return parent; | ||
} | ||
|
||
private void setParent(CheckConfiguration parent) { | ||
this.parent = parent; | ||
} | ||
} |
76 changes: 76 additions & 0 deletions
76
src/main/java/org/checkstyle/autofix/parser/ConfigurationLoader.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
/////////////////////////////////////////////////////////////////////////////////////////////// | ||
// checkstyle-openrewrite-recipes: Automatically fix Checkstyle violations with OpenRewrite. | ||
// Copyright (C) 2025 The Checkstyle OpenRewrite Recipes Authors | ||
// | ||
// Licensed under the Apache License, Version 2.0 (the "License"); | ||
// you may not use this file except in compliance with the License. | ||
// You may obtain a copy of the License at | ||
// | ||
// http://www.apache.org/licenses/LICENSE-2.0 | ||
// | ||
// Unless required by applicable law or agreed to in writing, software | ||
// distributed under the License is distributed on an "AS IS" BASIS, | ||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
// See the License for the specific language governing permissions and | ||
// limitations under the License. | ||
/////////////////////////////////////////////////////////////////////////////////////////////// | ||
|
||
package org.checkstyle.autofix.parser; | ||
|
||
import java.util.HashMap; | ||
import java.util.List; | ||
import java.util.Map; | ||
import java.util.Properties; | ||
|
||
import com.puppycrawl.tools.checkstyle.PropertiesExpander; | ||
import com.puppycrawl.tools.checkstyle.api.CheckstyleException; | ||
import com.puppycrawl.tools.checkstyle.api.Configuration; | ||
|
||
public final class ConfigurationLoader { | ||
|
||
private ConfigurationLoader() { | ||
// utility class | ||
} | ||
|
||
private static CheckConfiguration mapConfiguration(Configuration config) { | ||
final Map<String, String> properties = new HashMap<>(); | ||
final String[] propertyNames = config.getPropertyNames(); | ||
for (String propertyName : propertyNames) { | ||
try { | ||
final String value = config.getProperty(propertyName); | ||
properties.put(propertyName, value); | ||
|
||
} | ||
catch (CheckstyleException exception) { | ||
throw new IllegalStateException("Error getting property " + propertyName, | ||
exception); | ||
} | ||
} | ||
|
||
final Configuration[] checkstyleChildren = config.getChildren(); | ||
final CheckConfiguration[] simpleChildren = | ||
new CheckConfiguration[checkstyleChildren.length]; | ||
for (int index = 0; index < checkstyleChildren.length; index++) { | ||
simpleChildren[index] = mapConfiguration(checkstyleChildren[index]); | ||
} | ||
|
||
return new CheckConfiguration(config.getName(), properties, List.of(simpleChildren)); | ||
} | ||
|
||
public static CheckConfiguration loadConfiguration(String checkstyleConfigurationPath) { | ||
|
||
final Configuration checkstyleConfig; | ||
try { | ||
checkstyleConfig = com.puppycrawl.tools.checkstyle.ConfigurationLoader | ||
.loadConfiguration(checkstyleConfigurationPath, | ||
new PropertiesExpander(new Properties())); | ||
} | ||
catch (CheckstyleException exception) { | ||
throw new IllegalStateException("Failed to load configuration:" | ||
+ checkstyleConfigurationPath, exception); | ||
} | ||
|
||
return mapConfiguration(checkstyleConfig); | ||
} | ||
|
||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.