maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Hudson (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MCHECKSTYLE-337) checkstyle:check only supports xml output format, but the docs say it supports plain as well
Date Sun, 04 Jun 2017 17:39:04 GMT

    [ https://issues.apache.org/jira/browse/MCHECKSTYLE-337?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16036349#comment-16036349
] 

Hudson commented on MCHECKSTYLE-337:
------------------------------------

SUCCESS: Integrated in Jenkins build maven-plugins #8983 (See [https://builds.apache.org/job/maven-plugins/8983/])
[MCHECKSTYLE-337] checkstyle:check only supports xml output format, but the docs say it supports
plain as well
Submitted by: Stig Rohde Døssing

Adding support for 'plain' output file format in the 'check' goal. It is still not possible
to use it in combination with 'skipExec' because the plain format does not interact fully
with 'violationIgnore' (which can contain fully qualified class name, when Checkstyle plain
format only has the class simple name). (gboue: [http://svn.apache.org/viewvc/?view=rev&rev=1797596])
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337/invoker.properties
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337/pom.xml
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337/src
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337/src/main
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337/src/main/java
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337/src/main/java/org
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337/src/main/java/org/MyClass.java
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337/src/main/java/org/package-info.java
* (add) maven-checkstyle-plugin/src/it/MCHECKSTYLE-337/verify.groovy
* (edit) maven-checkstyle-plugin/src/main/java/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojo.java
* (add) maven-checkstyle-plugin/src/main/java/org/apache/maven/plugins/checkstyle/CompositeAuditListener.java
* (edit) maven-checkstyle-plugin/src/test/java/org/apache/maven/plugins/checkstyle/CheckstyleViolationCheckMojoTest.java
* (add) maven-checkstyle-plugin/src/test/plugin-configs/check-plugin-plain-output.xml


> checkstyle:check only supports xml output format, but the docs say it supports plain
as well
> --------------------------------------------------------------------------------------------
>
>                 Key: MCHECKSTYLE-337
>                 URL: https://issues.apache.org/jira/browse/MCHECKSTYLE-337
>             Project: Maven Checkstyle Plugin
>          Issue Type: Bug
>          Components: checkstyle:check
>    Affects Versions: 2.17
>            Reporter: Stig Rohde Døssing
>            Priority: Minor
>         Attachments: MCHECKSTYLE-337.patch, MCHECKSTYLE-337.patch, MCHECKSTYLE-337.patch
>
>
> The documentation for the check goal at https://maven.apache.org/plugins/maven-checkstyle-plugin/check-mojo.html#outputFileFormat
mentions "plain" as a valid option for file output. This is not true, the mojo only supports
XML.
> I'd prefer added support for plain output, but the docs should be fixed if that is not
possible.
> Taking a look at the code, it looks like the only reason plain isn't supported is because
the check mojo needs to parse the output file to figure out if there were style violations.
An option would be counting errors with the AuditListener instead, but this would break support
for skipExec. An alternative would be to output an extra XML result file if the output format
isn't XML.
> I'd be happy to implement either solution.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)

Mime
View raw message