Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[MCHECKSTYLE-355] Allow checkstyleRules next to configLocation

Open
#267 0 comments 0 reactions 0 assignees View on GitHub

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 by reproducing the reported Maven configuration with configLocation and checkstyleRules, then trace how the plugin handles these two settings. Identify the existing validation or configuration-merging entry point; done means inline rules override the corresponding configLocation rule without the current failure, with coverage for the LineLength example.

Written by the indexing model from the issue text.

Description

enhancement priority:minor

HerrDerb opened MCHECKSTYLE-355 and commented

Summary

Allow to define a configLocation and checkstyleRules resulting in inline checkstyle rules overriding configLocation checks. This would allow a dynamic checkstyle rule configuration.

 

Current behaviour
Currently when running the plugin with the following configuration

<configuration>
       <configLocation>google_checks.xml</configLocation>
       <checkstyleRules>
               <module name="LineLength">
                      <property name="max" value="120"/>
              </module>
       </checkstyleRules>
 </configuration>

 it fails and returns

Failed to execute goal org.apache.maven.plugins:maven-checkstyle-plugin:3.0.0:check (default) on project comlab-pom: If you use inline configuration for rules, don't specify a configLocation

Desired behaviour

The google check LineLenth is overriden by the inline check, defining a valid line length of 120 instead of 80.

 


No further details from MCHECKSTYLE-355

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

  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.