Resolve edge-case where Piccolo is on the project classpath (#668)

Author: jshiell

CHANGELOG.md

@@ -1,6 +1,7 @@
 
 # CheckStyle-IDEA Changelog
 
+* **5.108.1** Fixed: Resolved edge case if Piccolo is in the project classpath (#668).
 * **5.108.0** New: Added Checkstyle 10.25.1 & 10.26.0.
 * **5.107.0** New: Added Checkstyle 10.25.0.
 * **5.106.0** New: Added Checkstyle 10.24.0.

build.gradle.kts

@@ -19,7 +19,7 @@ plugins {
     id("org.infernus.idea.checkstyle.build")
 }
 
-version = "5.108.0"
+version = "5.108.1"
 
 intellijPlatform {
     pluginConfiguration {

src/main/java/org/infernus/idea/checkstyle/CheckstyleProjectService.java

@@ -43,9 +43,22 @@ private CheckstyleProjectService(@NotNull final Project project,
         this.project = project;
         supportedVersions = new VersionListReader().getSupportedVersions();
 
+        ensureAValidatingParsingIsSetIfPiccoloIsInClasspath();
+
         activateCheckstyleVersion(requestedVersion, thirdPartyJars);
     }
 
+    private static void ensureAValidatingParsingIsSetIfPiccoloIsInClasspath() {
+        // Piccolo is non-validating, but CS needs a validating parser, so we need to ensure that a validating parser
+        // is available if Piccolo is on the project classpath
+        try {
+            Class.forName("org.apache.xerces.jaxp.SAXParserFactoryImpl");
+            System.setProperty("com.bluecast.xml.ValidatingSAXParserFactory", "org.apache.xerces.jaxp.SAXParserFactoryImpl");
+        } catch (ClassNotFoundException ignored) {
+            // ignored
+        }
+    }
+
     @NotNull
     public static CheckstyleProjectService forVersion(@NotNull final Project project,
                                                       @Nullable final String requestedVersion,

src/main/resources/META-INF/plugin.xml

@@ -25,6 +25,7 @@
     <change-notes>
         <![CDATA[
 <ul>
+    <li>5.108.1: Fixed: Resolved edge case if Piccolo is in the project classpath (#668).</li>
     <li>5.108.0: New: Added Checkstyle 10.25.1 & 10.26.0.</li>
     <li>5.107.0: New: Added Checkstyle 10.25.0.</li>
     <li>5.106.0: New: Added Checkstyle 10.24.0.</li>
@@ -40,11 +41,6 @@
     <li>5.99.0: New: Added Checkstyle 10.20.2.</li>
     <li>5.99.0: New: Problems in the static scan now show the rules file that was the source of the check (#5).</li>
     <li>5.99.0: New: Added option to group results by package, severity, and rules file (#3).</li>
-    <li>5.98.0: New: Added Checkstyle 10.20.1.</li>
-    <li>5.97.0: Fixed: Refactored code to fix exception around API dependencies at initialisation (#655).</li>
-    <li>5.97.0: New: Added Checkstyle 10.19.0.</li>1
-    <li>5.96.0: Fixed: Refactored code to avoid IDEA triggering the wrong constructor (#653).</li>
-    <li>5.96.0: New: Added Checkstyle 10.18.2.</li>
     <li><em>For older changes please see the changelog.</em></li>
 </ul>
         ]]>