README.md

    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:

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

    ❇️ Spotless for Maven

    ❇️ 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<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 👍 👍 👍 ⬜
    json.gson.GsonStep 👍 ⬜ ⬜ ⬜
    json.JsonSimpleStep 👍 ⬜ ⬜ ⬜
    kotlin.KtLintStep 👍 👍 👍 ⬜
    kotlin.KtfmtStep 👍 👍 ⬜ ⬜
    kotlin.DiktatStep 👍 👍 ⬜ ⬜
    markdown.FreshMarkStep 👍 ⬜ ⬜ ⬜
    markdown.FlexmarkStep ⬜ 👍 ⬜ ⬜
    npm.PrettierFormatterStep 👍 👍 ⬜ ⬜
    npm.TsFmtFormatterStep 👍 👍 ⬜ ⬜
    pom.SortPomStepStep ⬜ 👍 ⬜ ⬜
    python.BlackStep 👍 ⬜ ⬜ ⬜
    scala.ScalaFmtStep 👍 👍 👍 ⬜
    sql.DBeaverSQLFormatterStep 👍 👍 👍 ⬜
    wtp.EclipseWtpFormatterStep 👍 👍 ⬜ ⬜
    (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

    项目简介

    Keep your code spotless

    🚀 Github 镜像仓库 🚀

    源项目地址 ⬇ ⬇ ⬇

    https://github.com/diffplug/spotless

    发行版本

    当前项目没有发行版本

    贡献者 241

    全部贡献者

    开发语言

    • Java 98.6 %
    • HTML 0.9 %
    • JavaScript 0.3 %
    • Roff 0.0 %
    • ANTLR 0.0 %