Git Product home page Git Product logo

Autostyle: fix code style automatically

Travis CI CI Status

Autostyle can format <java | kotlin | scala | sql | groovy | javascript | flow | typeScript | css | scss | less | jsx | vue | graphql | json | yaml | markdown | license headers | anything> using <Gradle>.

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). Autostyle 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 Autostyle' arsenal.

Current feature matrix

Feature / FormatterStep plugin-gradle (Your build tool here)
generic.EndWithNewlineStep 👍
generic.IndentStep 👍
generic.LicenseHeaderStep 👍
generic.ReplaceRegexStep 👍
generic.ReplaceStep 👍
generic.TrimTrailingWhitespaceStep 👍
java.GoogleJavaFormatStep 👍
java.ImportOrderStep 👍
java.RemoveUnusedImportsStep 👍
kotlin.KtLintStep 👍
markdown.FreshMarkStep 👍
npm.PrettierFormatterStep 👍
npm.TsFmtFormatterStep 👍
scala.ScalaFmtStep 👍
sql.DBeaverSQLFormatterStep 👍
(Your FormatterStep here)
Fast up-to-date checking 👍
Automatic idempotency safeguard 👍

Why are there empty squares? Many projects get harder to work on as they get bigger. Autostyle is easier to work on than ever, and one of the reasons why is that we don't require contributors to "fill the matrix". So far Autostyle works better with Gradle, however we would consider PRs 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

autostyle's Projects

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.