maven-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "richard (JIRA)" <>
Subject [jira] [Commented] (MCHECKSTYLE-308) Include config in checkstyle site results
Date Sat, 12 Sep 2015 19:32:45 GMT


richard commented on MCHECKSTYLE-308:

{quote}how do you expect to render that information?{quote}

My opinion would be to have the ruleset path on the top of "checkstyle.html" be a link to
the XML document. Just like it does for the java code in the xref directory, the XML view
will just be pure text with line numbers on the left side.

The XML view could be fancier, like the "Rules" section on "checkstyle.html", but I still
think a raw view needs to be available, but again thats just me.

> Include config in checkstyle site results
> -----------------------------------------
>                 Key: MCHECKSTYLE-308
>                 URL:
>             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:
> "The following document contains the results of Checkstyle 6.11-SNAPSHOT with D:\Rickys\Java\checkstyleWorkspaceEclipse\contribution\checkstyle-tester\my_check.xml
> 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

View raw message