Rough draft of configuring the plugin based on the Maven plugin configuration

Author: nrayburn-tech

build.gradle.kts

@@ -85,6 +85,7 @@ dependencies {
         intellijIdeaCommunity("2024.1.7")
 
         bundledPlugin("com.intellij.java")
+        bundledPlugin("org.jetbrains.idea.maven")
 
         testFramework(TestFrameworkType.Platform)
     }

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

@@ -25,6 +25,7 @@ public class PluginConfiguration {
     private final SortedSet<String> activeLocationIds;
     private final boolean scanBeforeCheckin;
     private final String lastActivePluginVersion;
+    private final boolean importSettingsFromMaven;
 
     PluginConfiguration(@NotNull final String checkstyleVersion,
                         @NotNull final ScanScope scanScope,
@@ -34,7 +35,8 @@ public class PluginConfiguration {
                         @NotNull final List<String> thirdPartyClasspath,
                         @NotNull final SortedSet<String> activeLocationIds,
                         final boolean scanBeforeCheckin,
-                        @Nullable final String lastActivePluginVersion) {
+                        @Nullable final String lastActivePluginVersion,
+                        final boolean importSettingsFromMaven) {
         this.checkstyleVersion = checkstyleVersion;
         this.scanScope = scanScope;
         this.suppressErrors = suppressErrors;
@@ -46,6 +48,7 @@ public class PluginConfiguration {
                 .collect(Collectors.toCollection(TreeSet::new));
         this.scanBeforeCheckin = scanBeforeCheckin;
         this.lastActivePluginVersion = lastActivePluginVersion;
+        this.importSettingsFromMaven = importSettingsFromMaven;
     }
 
     @NotNull
@@ -105,6 +108,10 @@ public boolean isScanBeforeCheckin() {
         return scanBeforeCheckin;
     }
 
+    public boolean isImportSettingsFromMaven() {
+        return importSettingsFromMaven;
+    }
+
     public boolean hasChangedFrom(final Object other) {
         return this.equals(other) && locationsAreEqual((PluginConfiguration) other);
     }
@@ -139,13 +146,14 @@ public boolean equals(final Object other) {
                 && Objects.equals(thirdPartyClasspath, otherDto.thirdPartyClasspath)
                 && Objects.equals(activeLocationIds, otherDto.activeLocationIds)
                 && Objects.equals(scanBeforeCheckin, otherDto.scanBeforeCheckin)
-                && Objects.equals(lastActivePluginVersion, otherDto.lastActivePluginVersion);
+                && Objects.equals(lastActivePluginVersion, otherDto.lastActivePluginVersion)
+                && Objects.equals(importSettingsFromMaven, otherDto.importSettingsFromMaven);
     }
 
     @Override
     public int hashCode() {
         return Objects.hash(checkstyleVersion, scanScope, suppressErrors, copyLibs, locations, thirdPartyClasspath,
-                activeLocationIds, scanBeforeCheckin, lastActivePluginVersion);
+                activeLocationIds, scanBeforeCheckin, lastActivePluginVersion, importSettingsFromMaven);
     }
 
 }

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

@@ -23,6 +23,7 @@ public final class PluginConfigurationBuilder {
     private SortedSet<String> activeLocationIds;
     private boolean scanBeforeCheckin;
     private String lastActivePluginVersion;
+    private boolean importSettingsFromMaven;
 
     private PluginConfigurationBuilder(@NotNull final String checkstyleVersion,
                                        @NotNull final ScanScope scanScope,
@@ -32,7 +33,8 @@ private PluginConfigurationBuilder(@NotNull final String checkstyleVersion,
                                        @NotNull final List<String> thirdPartyClasspath,
                                        @NotNull final SortedSet<String> activeLocationIds,
                                        final boolean scanBeforeCheckin,
-                                       @Nullable final String lastActivePluginVersion) {
+                                       @Nullable final String lastActivePluginVersion,
+                                       final boolean importSettingsFromMaven) {
         this.checkstyleVersion = checkstyleVersion;
         this.scanScope = scanScope;
         this.suppressErrors = suppressErrors;
@@ -42,6 +44,7 @@ private PluginConfigurationBuilder(@NotNull final String checkstyleVersion,
         this.activeLocationIds = activeLocationIds;
         this.scanBeforeCheckin = scanBeforeCheckin;
         this.lastActivePluginVersion = lastActivePluginVersion;
+        this.importSettingsFromMaven = importSettingsFromMaven;
     }
 
     public static PluginConfigurationBuilder defaultConfiguration(@NotNull final Project project) {
@@ -62,7 +65,8 @@ public static PluginConfigurationBuilder defaultConfiguration(@NotNull final Pro
                 Collections.emptyList(),
                 Collections.emptySortedSet(),
                 false,
-                CheckStylePlugin.version());
+                CheckStylePlugin.version(),
+                false);
     }
 
     public static PluginConfigurationBuilder testInstance(@NotNull final String checkstyleVersion) {
@@ -75,7 +79,8 @@ public static PluginConfigurationBuilder testInstance(@NotNull final String chec
                 Collections.emptyList(),
                 Collections.emptySortedSet(),
                 false,
-                "aVersion");
+                "aVersion",
+                false);
     }
 
     public static PluginConfigurationBuilder from(@NotNull final PluginConfiguration source) {
@@ -87,7 +92,8 @@ public static PluginConfigurationBuilder from(@NotNull final PluginConfiguration
                 source.getThirdPartyClasspath(),
                 source.getActiveLocationIds(),
                 source.isScanBeforeCheckin(),
-                source.getLastActivePluginVersion());
+                source.getLastActivePluginVersion(),
+                source.isImportSettingsFromMaven());
     }
 
     public PluginConfigurationBuilder withCheckstyleVersion(@NotNull final String newCheckstyleVersion) {
@@ -135,6 +141,11 @@ public PluginConfigurationBuilder withLastActivePluginVersion(final String newLa
         return this;
     }
 
+    public PluginConfigurationBuilder withImportSettingsFromMaven(final boolean importSettingsFromMaven) {
+        this.importSettingsFromMaven = importSettingsFromMaven;
+        return this;
+    }
+
     public PluginConfiguration build() {
         return new PluginConfiguration(
                 checkstyleVersion,
@@ -145,7 +156,8 @@ public PluginConfiguration build() {
                 Objects.requireNonNullElseGet(thirdPartyClasspath, ArrayList::new),
                 Objects.requireNonNullElseGet(activeLocationIds, TreeSet::new),
                 scanBeforeCheckin,
-                lastActivePluginVersion);
+                lastActivePluginVersion,
+                importSettingsFromMaven);
     }
 
     private static ConfigurationLocationFactory configurationLocationFactory(final Project project) {

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

@@ -82,6 +82,8 @@ static class ProjectSettings {
         private boolean copyLibs;
         @Tag
         private boolean scanBeforeCheckin;
+        @Tag
+        private boolean importSettingsFromMaven;
         @XCollection
         private List<String> thirdPartyClasspath;
         @XCollection
@@ -102,6 +104,7 @@ static ProjectSettings create(@NotNull final PluginConfiguration currentPluginCo
             projectSettings.suppressErrors = currentPluginConfig.isSuppressErrors();
             projectSettings.copyLibs = currentPluginConfig.isCopyLibs();
             projectSettings.scanBeforeCheckin = currentPluginConfig.isScanBeforeCheckin();
+            projectSettings.importSettingsFromMaven = currentPluginConfig.isImportSettingsFromMaven();
 
             projectSettings.thirdPartyClasspath = new ArrayList<>(currentPluginConfig.getThirdPartyClasspath());
             projectSettings.activeLocationIds = new ArrayList<>(currentPluginConfig.getActiveLocationIds());
@@ -147,7 +150,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)