apache / apache/maven-checkstyle-plugin

[MCHECKSTYLE-405] The checkstyle plugin should report the number of all violations

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

Description

**[Guillaume Nodet](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=gnt)** opened **[MCHECKSTYLE-405](https://issues.apache.org/jira/browse/MCHECKSTYLE-405?redirect=false)** and commented

When there is an error, the build looks like:

```java
[INFO] There is 1 error reported by Checkstyle 8.41.1 with config/maven_checks.xml ruleset.
[ERROR] src/main/java/org/apache/maven/execution/BuildResumptionDataRepository.java:[54,30] (whitespace) ParenPad: '(' is not followed by whitespace.

```

and when this error is fixed, the build then looks like:

```
[INFO] You have 0 Checkstyle violations.
```

The problem is that checkstyle never caches the results for files with violations, even at info or warning level. This cause the files to be always processed, without the user really being aware of any problem.

The number of violations at info or warning level should also be printed. In addition, if there are errors, the output should be logged at WARN level.

---

1 votes, 2 watchers

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the two output cases using config/maven_checks.xml and the Checkstyle 8.41.1 examples in the issue. Trace the plugin's violation reporting and file-result caching entry points; done means info and warning output includes the total violations, and error output is logged at WARN level.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.