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

spotless-maven-plugin: Allow to overwrite the recommended goal/phase for applying the formatting

Open
#1,988 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
45/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Stale
Tech stack
java

Research direction

Start in plugin-maven/src/main/java/com/diffplug/spotless/maven/SpotlessCheckMojo.java around line 83, where the runToFix message is hard-coded. Trace the Maven mojo parameters and verify that runToFix can be overridden while retaining its current default; done means the configured execution or build command is reflected in the guidance.

Written by the indexing model from the issue text.

Description

enhancement

In https://github.com/diffplug/spotless/blob/657926464aae27dee2c83c5b28ac6b7e52f2229a/plugin-maven/src/main/java/com/diffplug/spotless/maven/SpotlessCheckMojo.java#L83 the message Run 'mvn spotless:apply' to fix these violations. is hard-coded. In some complex setups the configuration for the apply goal only is different than applying it in the context of a regular build. Therefore it should be possible to overwrite the runToFix argument with a mojo parameter (but the default should obviously stay as is). That way you can run e.g. with a particular execution id or a full Maven build up to a certain phase (most probably with a dedicated profile or property parameter) to enable the reformatting.

Dominant language
Java
Stars
5.7k
Forks
560
Avg merge
1d 13h
Merged PRs (30d)
43

Contributor guide

Open the 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 diffplug/spotless

All issues in diffplug/spotless

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.