Add the ability to sync Maven Checkstyle plugin settings with the IDE settings

When the Maven sync action is triggered within the IDE, the project settings will be synced. This currently requires users to opt-in with a Checkstyle IntelliJ plugin setting.

Author: nrayburn-tech

build.gradle.kts

@@ -85,8 +85,10 @@ dependencies {
         intellijIdeaCommunity("2024.1.7")
 
         bundledPlugin("com.intellij.java")
+        bundledPlugin("org.jetbrains.idea.maven")
 
         testFramework(TestFrameworkType.Platform)
+        testFramework(TestFrameworkType.Plugin.Maven)
     }
 
     implementation("commons-io:commons-io:2.20.0")

src/main/java/org/infernus/idea/checkstyle/config/PluginConfiguration.java

@@ -24,6 +24,7 @@ public class PluginConfiguration {
     private final List<String> thirdPartyClasspath;
     private final SortedSet<String> activeLocationIds;
     private final boolean scanBeforeCheckin;
+    private final boolean importSettingsFromMaven;
 
     PluginConfiguration(@NotNull final String checkstyleVersion,
                         @NotNull final ScanScope scanScope,
@@ -33,7 +34,8 @@ public class PluginConfiguration {
                         @NotNull final SortedSet<ConfigurationLocation> locations,
                         @NotNull final List<String> thirdPartyClasspath,
                         @NotNull final SortedSet<String> activeLocationIds,
-                        final boolean scanBeforeCheckin) {
+                        final boolean scanBeforeCheckin,
+                        final boolean importSettingsFromMaven) {
         this.checkstyleVersion = checkstyleVersion;
         this.scanScope = scanScope;
         this.suppressErrors = suppressErrors;
@@ -45,6 +47,7 @@ public class PluginConfiguration {
                 .filter(Objects::nonNull)
                 .collect(Collectors.toCollection(TreeSet::new));
         this.scanBeforeCheckin = scanBeforeCheckin;
+        this.importSettingsFromMaven = importSettingsFromMaven;
     }
 
     @NotNull
@@ -103,6 +106,10 @@ public boolean isScanBeforeCheckin() {
         return scanBeforeCheckin;
     }
 
+    public boolean isImportSettingsFromMaven() {
+        return importSettingsFromMaven;
+    }
+
     public boolean hasChangedFrom(final Object other) {
         return this.equals(other) && locationsAreEqual((PluginConfiguration) other);
     }
@@ -137,13 +144,14 @@ public boolean equals(final Object other) {
                 && Objects.equals(locations, otherDto.locations)
                 && Objects.equals(thirdPartyClasspath, otherDto.thirdPartyClasspath)
                 && Objects.equals(activeLocationIds, otherDto.activeLocationIds)
-                && Objects.equals(scanBeforeCheckin, otherDto.scanBeforeCheckin);
+                && Objects.equals(scanBeforeCheckin, otherDto.scanBeforeCheckin)
+                && Objects.equals(importSettingsFromMaven, otherDto.importSettingsFromMaven);
     }
 
     @Override
     public int hashCode() {
         return Objects.hash(checkstyleVersion, scanScope, suppressErrors, copyLibs, scrollToSource,
-                locations, thirdPartyClasspath, activeLocationIds, scanBeforeCheckin);
+                locations, thirdPartyClasspath, activeLocationIds, scanBeforeCheckin, importSettingsFromMaven);
     }
 
 }

src/main/java/org/infernus/idea/checkstyle/config/PluginConfigurationBuilder.java

@@ -21,6 +21,7 @@ public final class PluginConfigurationBuilder {
     private List<String> thirdPartyClasspath;
     private SortedSet<String> activeLocationIds;
     private boolean scanBeforeCheckin;
+    private boolean importSettingsFromMaven;
 
     private PluginConfigurationBuilder(@NotNull final String checkstyleVersion,
                                        @NotNull final ScanScope scanScope,
@@ -30,7 +31,8 @@ private PluginConfigurationBuilder(@NotNull final String checkstyleVersion,
                                        @NotNull final SortedSet<ConfigurationLocation> locations,
                                        @NotNull final List<String> thirdPartyClasspath,
                                        @NotNull final SortedSet<String> activeLocationIds,
-                                       final boolean scanBeforeCheckin) {
+                                       final boolean scanBeforeCheckin,
+                                       final boolean importSettingsFromMaven) {
         this.checkstyleVersion = checkstyleVersion;
         this.scanScope = scanScope;
         this.suppressErrors = suppressErrors;
@@ -40,6 +42,7 @@ private PluginConfigurationBuilder(@NotNull final String checkstyleVersion,
         this.thirdPartyClasspath = thirdPartyClasspath;
         this.activeLocationIds = activeLocationIds;
         this.scanBeforeCheckin = scanBeforeCheckin;
+        this.importSettingsFromMaven = importSettingsFromMaven;
     }
 
     public static PluginConfigurationBuilder defaultConfiguration(@NotNull final Project project) {
@@ -60,6 +63,7 @@ public static PluginConfigurationBuilder defaultConfiguration(@NotNull final Pro
                 defaultLocations,
                 Collections.emptyList(),
                 Collections.emptySortedSet(),
+                false,
                 false);
     }
 
@@ -73,6 +77,7 @@ public static PluginConfigurationBuilder testInstance(@NotNull final String chec
                 Collections.emptySortedSet(),
                 Collections.emptyList(),
                 Collections.emptySortedSet(),
+                false,
                 false);
     }
 
@@ -85,7 +90,8 @@ public static PluginConfigurationBuilder from(@NotNull final PluginConfiguration
                 source.getLocations(),
                 source.getThirdPartyClasspath(),
                 source.getActiveLocationIds(),
-                source.isScanBeforeCheckin());
+                source.isScanBeforeCheckin(),
+                source.isImportSettingsFromMaven());
     }
 
     public PluginConfigurationBuilder withCheckstyleVersion(@NotNull final String newCheckstyleVersion) {
@@ -133,6 +139,11 @@ public PluginConfigurationBuilder withScanScope(@NotNull final ScanScope newScan
         return this;
     }
 
+    public PluginConfigurationBuilder withImportSettingsFromMaven(final boolean importSettingsFromMaven) {
+        this.importSettingsFromMaven = importSettingsFromMaven;
+        return this;
+    }
+
     public PluginConfiguration build() {
         return new PluginConfiguration(
                 checkstyleVersion,
@@ -143,7 +154,8 @@ public PluginConfiguration build() {
                 Objects.requireNonNullElseGet(locations, TreeSet::new),
                 Objects.requireNonNullElseGet(thirdPartyClasspath, ArrayList::new),
                 Objects.requireNonNullElseGet(activeLocationIds, TreeSet::new),
-                scanBeforeCheckin);
+                scanBeforeCheckin,
+                importSettingsFromMaven);
     }
 
     private static ConfigurationLocationFactory configurationLocationFactory(final Project project) {

src/main/java/org/infernus/idea/checkstyle/config/ProjectConfigurationState.java

@@ -84,6 +84,8 @@ static class ProjectSettings {
         private boolean scrollToSource;
         @Tag
         private boolean scanBeforeCheckin;
+        @Tag
+        private boolean importSettingsFromMaven;
         @XCollection
         private List<String> thirdPartyClasspath;
         @XCollection
@@ -105,6 +107,7 @@ static ProjectSettings create(@NotNull final PluginConfiguration currentPluginCo
             projectSettings.copyLibs = currentPluginConfig.isCopyLibs();
             projectSettings.scrollToSource = currentPluginConfig.isScrollToSource();
             projectSettings.scanBeforeCheckin = currentPluginConfig.isScanBeforeCheckin();
+            projectSettings.importSettingsFromMaven = currentPluginConfig.isImportSettingsFromMaven();
 
             projectSettings.thirdPartyClasspath = new ArrayList<>(currentPluginConfig.getThirdPartyClasspath());
             projectSettings.activeLocationIds = new ArrayList<>(currentPluginConfig.getActiveLocationIds());
@@ -151,7 +154,8 @@ PluginConfigurationBuilder populate(@NotNull final PluginConfigurationBuilder bu
                         .withScanBeforeCheckin(scanBeforeCheckin)
                         .withThirdPartyClassPath(requireNonNullElseGet(thirdPartyClasspath, ArrayList::new))
                         .withLocations(deserialiseLocations(project))
-                        .withActiveLocationIds(new TreeSet<>(requireNonNullElseGet(activeLocationIds, ArrayList::new)));
+                        .withActiveLocationIds(new TreeSet<>(requireNonNullElseGet(activeLocationIds, ArrayList::new)))
+                        .withImportSettingsFromMaven(importSettingsFromMaven);
             }
 
             return new LegacyProjectConfigurationStateDeserialiser(project)