Skip to content

New parameter(s) to configure visibility of sections in Checkstyle reports #173

@seekM

Description

@seekM

New feature, improvement proposal

Please consider the following Checkstyle report created with mvn:site:

Image

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions