Show severity as text instead of skin images

Open Beginner friendly
#735 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Active
Tech stack
java
Domain
tooling

Research direction

The icon lookup is in CheckstyleReportRenderer.iconSeverity, which returns the images/icon_*_sml.gif paths. Read how each severity call site prints the severity name beside the icon, then remove the image output so the text stands alone. Done when the rendered report contains no references to the icon files and every severity still appears as text, which the report renderer tests should confirm.

Written by the indexing model from the issue text.

Description

enhancement

The Checkstyle report draws each severity with images/icon_info_sml.gif, icon_warning_sml.gif or icon_error_sml.gif (CheckstyleReportRenderer.iconSeverity). Those files belong to the site skin, not to the plugin, so a skin that does not ship them leaves broken images in the report. Every call already prints the severity name next to the image, so the image can go and the text can carry the severity on its own.

maven-project-info-reports-plugin (apache/maven-project-info-reports-plugin#688), maven-surefire (apache/maven-surefire#3565) and maven-changes-plugin (apache/maven-changes-plugin#685) made the same change. The Fluido skin can drop the icons once report plugins stop referencing them: apache/maven-fluido-skin#364.

Dominant language
Java
Stars
98
Forks
72
Avg merge
8h 29m
Merged PRs (30d)
12

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/maven-checkstyle-plugin

All issues in apache/maven-checkstyle-plugin

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.