New parameter(s) to configure visibility of sections in Checkstyle reports
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- java
- Domain
- build-system
Research direction
Start with the checkstyle:checkstyle and checkstyle:checkstyle-aggregate goals and compare the existing enableFilesSummary and enableRulesSummary parameters. Define how the Files, Rules, and Details sections behave when empty or populated, then verify the behavior in reports generated with mvn:site.
Written by the indexing model from the issue text.
Description
New feature, improvement proposal
Please consider the following Checkstyle report created with mvn:site:
As can be seen, the "Files", "Rules" and "Details" sections are empty, yet their headings and partially the tables are still displayed.
Would it be possible to introduce one new general optional parameter (or maybe a new optional parameter for each of these three sections) which hides a section if it is empty and displays it if it's not empty?
Reasons:
- In my opinon having these empty sections there doesn't add additional information.
- Personally, I don't think this looks pleasant to the eye.
- While one might argue that having these sections there all the times might be good for consistency reasons, for someone who is not familar with Checkstyle reports (or maybe Maven reports in general) this might be confusing: One might wonder what these empty sections mean - for example, seeing this for first time, I was wondering if the Checkstyle plugin maybe was not configured correctly (I was wondering if maybe the checked (yet correct) files should be listed under "Files" or if maybe the used rules to check those files should be displayed at "Rules").
I couldn't find such a parameter for the checkstyle:checkstyle or checkstyle:checkstyle-aggregate goal.
What I did find were the parameters <enableFilesSummary> and <enableRulesSummary> (I couldn't find a parameter like <enableDetailsSummary>), however, those hide / display the respective sections independent of whether they are empty or not.
- Dominant language
- Java
- Stars
- 98
- Forks
- 69
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 8
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/maven-checkstyle-plugin
-
maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
apache/maven-checkstyle-plugin#718 ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 38/100
apache/maven-checkstyle-plugin#675 ·
Maintainers usually reply within 1 day
-
Update dependencies.May be free again A pull request for this issue was closed without being merged. Openbug
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
apache/maven-checkstyle-plugin#664 ·
Maintainers usually reply within 1 day
-
DefaultCheckstyleExecutor should be a failure, not an errorPossibly taken @efegokdemir claimed this 31 days ago. Openbug
Difficulty 3/5 1-2 days Newbie friendliness 58/100
apache/maven-checkstyle-plugin#656 · 1 comment ·
Maintainers usually reply within 1 day
-
Add ability to print warnings when `failOnViolation: true` and `violationSeverity: error`Possibly taken @efegokdemir claimed this 30 days ago. Openenhancement
Difficulty 3/5 1-2 days Newbie friendliness 50/100
apache/maven-checkstyle-plugin#648 · 5 comments ·
Maintainers usually reply within 1 day
All issues in apache/maven-checkstyle-plugin
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
[Bug]: REST API URL starting with "http" but no scheme (e.g. httpbin.org/get) is not given an http:// prefixPossibly taken @ItsDeadlyProgrammer claimed this 1 day ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
appsmithorg/appsmith#42471 · 1 comment ·
Maintainers usually reply within 2 days
-
code-maintenance
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
bug priority: medium Review effort [1-5]: 3 status: needs-triage type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
carlos-emr/carlos#5258 ·
Maintainers usually reply within 1 day