29 lines
795 B
Markdown
29 lines
795 B
Markdown
# Spotless
|
|
|
|
[Spotless](https://github.com/diffplug/spotless) is a pluggable formatter
|
|
for Gradle and Android.
|
|
|
|
In our current configuration, Spotless includes the
|
|
[Google Java Format plug-in](https://github.com/google/google-java-format)
|
|
which formats all our Java code using the Google Java coding style guidelines,
|
|
and [ktlint](https://ktlint.github.io/) which formats all
|
|
our Kotlin code using the official Kotlin coding convention and Android Kotlin
|
|
Style Guide.
|
|
|
|
## Run Locally
|
|
|
|
The mozlint integration of spotless can be run using mach:
|
|
|
|
```{eval-rst}
|
|
.. parsed-literal::
|
|
|
|
$ mach lint --linter android-format
|
|
```
|
|
|
|
Alternatively, omit the `--linter android-format` and run all configured linters, which will include
|
|
spotless.
|
|
|
|
## Autofix
|
|
|
|
The spotless linter provides a `--fix` option.
|