apache / apache/maven-checkstyle-plugin

[MCHECKSTYLE-289] enableRulesSummary option does not show Rules with default configuration

Open
#590 7 comments 0 reactions 0 assignees View on GitHub
bug priority:major
Dominant language
Java
Stars
97
Forks
67
Avg merge
14h 50m
Merged PRs (30d)
6

Description

**[Roman Ivanov](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=romani)** opened **[MCHECKSTYLE-289](https://issues.apache.org/jira/browse/MCHECKSTYLE-289?redirect=false)** and commented

In Checkstyle development we use maven plugin a lot.

Option:
http://maven.apache.org/plugins/maven-checkstyle-plugin/checkstyle-mojo.html#enableRulesSummary

that option is convenient to estimate on what Rule set it was generated.
But it does not show Rule if it configured by default.
It that is bug- please fix, if that done on good reason please provide additional option.

Example:
http://checkstyle.sourceforge.net/reports/google-style/guava/
https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml#L37

Example where it not clear on what config that report was generated:
http://damianszczepanik.github.io/sevntu.checkstyle/sevntu.checkstyle/pull/327/index.html

---

**Issue Links:**
- [MCHECKSTYLE-217](https://issues.apache.org/jira/browse/MCHECKSTYLE-217) Add parameter which skips rule rows which do not have any violations

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading the enableRulesSummary option documentation and comparing the linked Google Style and sevntu.checkstyle report examples. Check how rules with default configuration are represented, including the related MCHECKSTYLE-217 issue. Done means reports make the complete rule set clear, including rules using default configuration, without hiding existing behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.