maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Roman Ivanov (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (MCHECKSTYLE-308) Include config in checkstyle site results
Date Sat, 12 Sep 2015 14:15:45 GMT

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

Roman Ivanov commented on MCHECKSTYLE-308:
------------------------------------------

After using HTML plugin reports for few years to verify each violations in report, I confirm
that such update will be very useful.

It even make sense to raise priority as this feature will be used in checkstyle development
process right after it be implemented.

> Include config in checkstyle site results
> -----------------------------------------
>
>                 Key: MCHECKSTYLE-308
>                 URL: https://issues.apache.org/jira/browse/MCHECKSTYLE-308
>             Project: Maven Checkstyle Plugin
>          Issue Type: Improvement
>          Components: checkstyle:checkstyle
>    Affects Versions: 2.16
>         Environment: Windows 7, Eclipse Kepler SR2
>            Reporter: richard
>            Priority: Minor
>
> When running "mvn site" to create a checkstyle report of code, it includes the file location
of the configuration file it is running with, but it doesn't include the physical configuration
in the report.
> Example: http://rnveach.github.io/checkstyle/checkstyle.html
> "The following document contains the results of Checkstyle 6.11-SNAPSHOT with D:\Rickys\Java\checkstyleWorkspaceEclipse\contribution\checkstyle-tester\my_check.xml
ruleset."
> When showing this report to others as a proof of some fix, especially over the internet,
it would be worth it to include the configuration in the reports to verify that they are using
the correct checks and to be able to reproduce any warning/errors they have with their code.
> To the viewers of the report, a mis-configured configuration file can look the same as
a properly configured one with no errors/warnings.
> It is also possible to use a local configuration on the hard drive, instead of a global
one, which will hide the settings of the configuration and not provide a visualization of
its contents at the time the report was run.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Mime
View raw message