android-format.rst (813B)
1 Spotless 2 ======== 3 4 `Spotless <https://github.com/diffplug/spotless>`__ is a pluggable formatter 5 for Gradle and Android. 6 7 In our current configuration, Spotless includes the 8 `Google Java Format plug-in <https://github.com/google/google-java-format>`__ 9 which formats all our Java code using the Google Java coding style guidelines, 10 and `ktlint <https://ktlint.github.io/>`__ which formats all 11 our Kotlin code using the official Kotlin coding convention and Android Kotlin 12 Style Guide. 13 14 15 Run Locally 16 ----------- 17 18 The mozlint integration of spotless can be run using mach: 19 20 .. parsed-literal:: 21 22 $ mach lint --linter android-format 23 24 Alternatively, omit the ``--linter android-format`` and run all configured linters, which will include 25 spotless. 26 27 28 Autofix 29 ------- 30 31 The spotless linter provides a ``--fix`` option.