[jira] [Commented] (MCHECKSTYLE-337) checkstyle:check only supports xml output format, but the docs say it supports plain as well

["Guillaume Boué (JIRA)" <ji...@apache.org>]

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

Guillaume Boué commented on MCHECKSTYLE-337:
--------------------------------------------

I'm not sure why the first option would break support for {{skipExec}}. But I don't think the {{plain}} output format can be supported as-is with [Checkstyle definition of "plain"|http://checkstyle.sourceforge.net/cmdline.html#Command_line_usage]... The log messages produced by {{DefaultLogger}} does not include the fully qualified name of the check's class (only the simple name), and so it wouldn't work in combination with {{violationIgnore}}. We could have our own formatter for the messages, but then using {{skipExec}} on a result produced by Checkstyle could possibly not be interpreted correctly.

> 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
>
> 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)