Skip to content

diffplug/spotless

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a205607 Β· Jan 25, 2023
Jan 24, 2023
Jan 24, 2023
Nov 30, 2016
Jan 24, 2023
Jan 24, 2023
Jan 25, 2023
Jan 25, 2023
Jan 25, 2023
Jan 25, 2023
Jan 9, 2023
Jan 24, 2023
Jan 12, 2023
Jan 25, 2023
Feb 15, 2019
Jan 1, 2023
Jan 3, 2017
Feb 16, 2018
Mar 15, 2014
Oct 4, 2020
Jan 6, 2022
Jan 19, 2023
Apr 9, 2021
Dec 18, 2022
Jan 17, 2023
Nov 25, 2022
Nov 25, 2022
Aug 25, 2022
Jan 19, 2023

Repository files navigation

Spotless: Keep your code spotless

Circle CI Live chat License Apache

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 | sql | typeScript | vue | yaml | anything> using <gradle | maven | anything>.

You probably want one of the links below:

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<String, String>, 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<String, String> 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 πŸ‘ πŸ‘ πŸ‘ ⬜
Misconfigured encoding safeguard πŸ‘ πŸ‘ πŸ‘ ⬜
Toggle with spotless:off and spotless:on πŸ‘ πŸ‘ ⬜ ⬜
Ratchet from origin/main or other git ref πŸ‘ πŸ‘ ⬜ ⬜
Define line endings using git πŸ‘ πŸ‘ πŸ‘ ⬜
Fast incremental format and up-to-date check πŸ‘ πŸ‘ ⬜ ⬜
Fast format on fresh checkout using buildcache πŸ‘ ⬜ ⬜ ⬜
generic.EndWithNewlineStep πŸ‘ πŸ‘ ⬜ ⬜
generic.IndentStep πŸ‘ πŸ‘ ⬜ ⬜
generic.Jsr223Step ⬜ πŸ‘ ⬜ ⬜
generic.LicenseHeaderStep πŸ‘ πŸ‘ πŸ‘ ⬜
generic.NativeCmdStep πŸ‘ πŸ‘ ⬜ ⬜
generic.ReplaceRegexStep πŸ‘ πŸ‘ ⬜ ⬜
generic.ReplaceStep πŸ‘ πŸ‘ ⬜ ⬜
generic.TrimTrailingWhitespaceStep πŸ‘ πŸ‘ ⬜ ⬜
antlr4.Antlr4FormatterStep πŸ‘ πŸ‘ ⬜ ⬜
cpp.ClangFormatStep πŸ‘ ⬜ ⬜ ⬜
cpp.EclipseFormatterStep πŸ‘ πŸ‘ πŸ‘ ⬜
groovy.GrEclipseFormatterStep πŸ‘ πŸ‘ πŸ‘ ⬜
java.GoogleJavaFormatStep πŸ‘ πŸ‘ πŸ‘ ⬜
java.ImportOrderStep πŸ‘ πŸ‘ πŸ‘ ⬜
java.PalantirJavaFormatStep πŸ‘ πŸ‘ ⬜ ⬜
java.RemoveUnusedImportsStep πŸ‘ πŸ‘ πŸ‘ ⬜
java.EclipseJdtFormatterStep πŸ‘ πŸ‘ πŸ‘ ⬜
java.FormatAnnotationsStep πŸ‘ πŸ‘ ⬜ ⬜
json.gson.GsonStep πŸ‘ πŸ‘ ⬜ ⬜
json.JacksonJsonStep πŸ‘ πŸ‘ ⬜ ⬜
json.JsonSimpleStep πŸ‘ πŸ‘ ⬜ ⬜
kotlin.KtLintStep πŸ‘ πŸ‘ πŸ‘ ⬜
kotlin.KtfmtStep πŸ‘ πŸ‘ ⬜ ⬜
kotlin.DiktatStep πŸ‘ πŸ‘ ⬜ ⬜
markdown.FreshMarkStep πŸ‘ ⬜ ⬜ ⬜
markdown.FlexmarkStep ⬜ πŸ‘ ⬜ ⬜
npm.EslintFormatterStep πŸ‘ πŸ‘ ⬜ ⬜
npm.PrettierFormatterStep πŸ‘ πŸ‘ ⬜ ⬜
npm.TsFmtFormatterStep πŸ‘ πŸ‘ ⬜ ⬜
pom.SortPomStep ⬜ πŸ‘ ⬜ ⬜
python.BlackStep πŸ‘ ⬜ ⬜ ⬜
scala.ScalaFmtStep πŸ‘ πŸ‘ πŸ‘ ⬜
sql.DBeaverSQLFormatterStep πŸ‘ πŸ‘ πŸ‘ ⬜
wtp.EclipseWtpFormatterStep πŸ‘ πŸ‘ ⬜ ⬜
yaml.JacksonYamlStep πŸ‘ πŸ‘ ⬜ ⬜
(Your FormatterStep here) ⬜ ⬜ ⬜ ⬜

Why are there empty squares?

Many projects get harder to work on as they get bigger. Spotless is easier to work on than ever, and one of the reasons why is that we don't require contributors to "fill the matrix". If you want to add Bazel support, we'd happily accept the PR even if it only supports the one formatter you use. And if you want to add FooFormatter support, we'll happily accept the PR even if it only supports the one build system you use.

Once someone has filled in one square of the formatter/build system matrix, it's easy for interested parties to fill in any empty squares, since you'll now have a working example for every piece needed.

Acknowledgements