checkstyle / checkstyle/eclipse-cs
RFE: Remote Configuration allow jar to be added to classpath like maven plugin dependencies
- Dominant language
- Java
- Stars
- 105
- Forks
- 65
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 21
Description
See #272 for background.
RFE: alllow Remote Configuration to specify both config location and add JARs to the classpath of checkstyle (as maven does).
When both the configuration and SuppressionFilter XML are inside a JAR, Eclipse-CS can use a Remote Configuration and pass the configuration location to checkstyle as: `jar:file:!/path-to-configuration-XML` — at least this is how m2e-code-quality parsed the corresponding maven XML. However the SuppressionFilter XML cannot be located as the JAR is not on the classpath.
Wildfly is an example that puts both the configuration and SuppressionFilter XML inside a JAR.
For comparison: maven with plugin dependencies adds the JAR to the classpath; it specifies the configuration with a path like `/wildfly-checkstyle/checkstyle.xml`; the SupppressionFilter `/wildfly-checkstyle/suppression.xml` is found on the classpath.
Side note: there is a [PR](https://github.com/apache/maven-checkstyle-plugin/pull/36) to maven checkstyle by @qxo to do the reverse and have maven support `${config_loc}`; but this would require wildfly to change their JAR.
It would be good if Eclipse-CS could support the equivalent of this:
```
* configLocation is inside the JAR
* it references the SuppressionFilter as /wildfly-checkstyle/suppression.xml
which is also inside the JAR
* Eclipse-CS jar:file:wildfly-checkstyle-config-1.0.7.Final.jar!/wildfly-checkstyle/checkstyle.xml is the
configLocation; subsequently /wildfly-checkstyle/suppression.xml can't be found (JAR not on classpath
when checkstyle is invoked)
org.apache.maven.plugins
maven-checkstyle-plugin
${version.checkstyle.plugin}
wildfly-checkstyle/checkstyle.xml
true
${project.build.sourceDirectory}
**/*.properties,**/*.xml
true
true
true
true
true
org.wildfly.checkstyle
wildfly-checkstyle-config
${version.org.wildfly.checkstyle-config}
check-style
compile
checkstyle
```
Contributor guide
Assessment
This issue has not been assessed yet.