[MCHECKSTYLE-308] Include config in checkstyle site results

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 2.16
• Component/s: checkstyle:checkstyle
• Environment: Windows 7, Eclipse Kepler SR2
• Assignee: Unassigned
• Reporter: richard
• Created: 12/Sep/15 14:07
• Updated: 15/Dec/19 18:18

Description

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.

Issue Links

• relates to: MCHECKSTYLE-282 add info on ruleset used in report intro