apache / apache/maven-checkstyle-plugin

[MCHECKSTYLE-308] Include config in checkstyle site results

Open
#605 8 comments 0 reactions 0 assignees View on GitHub
enhancement priority:minor
Dominant language
Java
Stars
97
Forks
67
Avg merge
14h 50m
Merged PRs (30d)
6

Description

**[richard](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=rveach)** opened **[MCHECKSTYLE-308](https://issues.apache.org/jira/browse/MCHECKSTYLE-308?redirect=false)** and commented

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.

---

**Affects:** 2.16

**Issue Links:**
- [MCHECKSTYLE-282](https://issues.apache.org/jira/browse/MCHECKSTYLE-282) add info on ruleset used in report intro

2 votes, 5 watchers

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by running `mvn site` and reviewing the generated checkstyle.html report, using the example report in the issue as a baseline. Trace how the report currently identifies its ruleset and make the physical configuration visible in the report so viewers can verify the checks and reproduce the results.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.