diffplug /spotless

Keep your code spotless

★ 5,730⑂ 569👁 30⑃ 1,841● 1,269▤ 87
JavaApache-2.0Created 2015-04-27
Download: Maven Plugin v3.11.0maven/3.11.0 ↓3.11.02026-11-02
+1
Daily
5,730
stars
569
forks
30
watchers
1,841
prs
1,269
issues
87
releases

README

Spotless: Keep your code spotless





Spotless can format <antlr | c | c | c++ | css | flow | graphql | groovy | html | java | javascript | json | jsx | kotlin | less | license headers | markdown | objective-c | protobuf | python | scala | scss | shell | sql | typeScript | vue | yaml | anything using <gradle | maven | sbt | anything.

You probably want one of the links below:

 ❇️ Spotless for Gradle (with integrations for VS Code and IntelliJ with Spotless Daemon or Spotless Gradle)

console
user@machine repo % ./gradlew build
:spotlessJavaCheck FAILED
  The following files had format violations:
  src\main\java\com\diffplug\gradle\spotless\FormatExtension.java
    -\t\t····if·(targets.length·==·0)·{
    +\t\tif·(targets.length·==·0)·{
  Run './gradlew spotlessApply' to fix these violations.
user@machine repo % ./gradlew spotlessApply
:spotlessApply
BUILD SUCCESSFUL
user@machine repo % ./gradlew build
BUILD SUCCESSFUL


 ❇️ Spotless for Maven

console
user@machine repo % mvn spotless:check
[ERROR]   The following files had format violations:
[ERROR]  src\main\java\com\diffplug\gradle\spotless\FormatExtension.java
[ERROR]    -\t\t····if·(targets.length·==·0)·{
[ERROR]    +\t\tif·(targets.length·==·0)·{
[ERROR]  Run 'mvn spotless:apply' to fix these violations.
user@machine repo % mvn spotless:apply
[INFO] BUILD SUCCESS
user@machine repo % mvn spotless:check
[INFO] BUILD SUCCESS


 ❇️ Spotless for SBT (external for now)
 Other build systems

 How it works (for potential contributors)

Ideally, a code formatter can do more than just find formatting errors - it should fix them as well. Such a formatter is just a Function, which returns a formatted version of its potentially unformatted input.

It's easy to build such a function, but there are some gotchas and lots of integration work (newlines, character encodings, idempotency, git ratcheting, and build-system integration). Spotless tackles those for you so you can focus on just a simple Function which can compose with any of the other formatters and build tools in Spotless' arsenal.

 Current feature matrix


| Feature / FormatterStep                       | gradle | maven | sbt | (Your build tool here) |
| --------------------------------------------- | ------------- | ------------ | ------------ | --------|
| Automatic idempotency safeguard | :+1:    | :+1:      | :+1:      | :white_large_square:  |
| Misconfigured encoding safeguard | :+1:    | :+1:      | :+1:       | :white_large_square:  |
| Toggle with spotless:off and spotless:on | :+1:    | :+1:      | :white_large_square:       | :white_large_square:  |
| Ratchet from origin/main or other git ref | :+1:    | :+1:      | :white_large_square:       | :white_large_square:  |
| Define line endings using git | :+1:    | :+1:      | :+1:       | :white_large_square:  |
| Fast incremental format and up-to-date check   | :+1:      | :+1:      | :white_large_square:       | :white_large_square:  |
| Fast format on fresh checkout using build

Top issues

Discussions

Latest release

Maven Plugin v3.11.0 maven/3.11.0 2026-11-02
Added
- Add false to  to disable google-java-format's non-whitespace cleanups. (3157)
- Add a  parameter to . (3151)  
  Overrides the 100-column limit prescribed by the GOOGLE and AOSP styles; requires google-java-format 2.0.0 or later.
 Changes
- Bump default google-java-format version 1.36.1 - 2.0.0.  (3157)  
  This version applies some small non-whitespace cleanups by default (removing redundant semicolons, empty annotation parentheses, and parentheses around single lambda parameters), which can be disabled with false.

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON