Spotless: Keep your code spotless

Ideally, a code formatter can do more than just find formatting errors - it should fix them as well. Such a formatter is really 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, 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	plugin-gradle	plugin-maven	(Your build tool here)
`generic.EndWithNewlineStep`	👍	⬜	⬜
`generic.IndentStep`	👍	⬜	⬜
`generic.LicenseHeaderStep`	👍	⬜	⬜
`generic.ReplaceRegexStep`	👍	⬜	⬜
`generic.ReplaceStep`	👍	⬜	⬜
`generic.TrimTrailingWhitespaceStep`	👍	⬜	⬜
`groovy.GrEclipseFormatterStep`	👍	⬜	⬜
`java.GoogleJavaFormatStep`	👍	⬜	⬜
`java.ImportOrderStep`	👍	⬜	⬜
`java.EclipseFormatterStep`	👍	⬜	⬜
`kotlin.KtLintStep`	👍	⬜	⬜
`markdown.FreshMarkStep`	👍	⬜	⬜
`scala.ScalaFmtStep`	👍	⬜	⬜
`sql.DBeaverSQLFormatterStep`	👍	⬜	⬜
(Your FormatterStep here)	⬜	⬜	⬜
Fast up-to-date checking	👍	⬜	⬜
Automatic idempotency safeguard	👍	⬜	⬜

Acknowledgements

Thanks to Baptiste Mesta for
- porting the DBeaver formatter to Spotless, and thanks to DBeaver and its authors for their excellent SQL formatter.
- making license headers date-aware #180
Thanks to Jonathan Bluett-Duncan for
- implementing up-to-date checking #31
- breaking spotless into libraries #56
- lots of other things, but especially the diff support in spotlessCheck
Thanks to Frank Vennemeyer for Groovy support via greclipse.
Thanks to Stefan Oehme for tons of help on the internal mechanics of Gradle.
Formatting by Eclipse
- Special thanks to Mateusz Matela for huge improvements to the eclipse code formatter!
Thanks to Stanley Shyiko for his help integrating ktlint.
Thanks to Jonathan Leitschuh for adding ktlint support for Gradle Kotlin DSL files.
Originally forked from gradle-format-plugin by Youri Bonnaffé.
Thanks to Gábor Bernát for improvements to logging and multi-project support.
Thanks to Andrew Oberstar for improvements to formatting java source in non-java source sets. PR #60.
Import ordering from EclipseCodeFormatter.
Built by gradle.
Tested by junit.
Maintained by DiffPlug.

License

lutovich/spotless

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages