File: android-format.rst

package info (click to toggle)
firefox 143.0.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,617,328 kB
  • sloc: cpp: 7,478,492; javascript: 6,417,157; ansic: 3,720,058; python: 1,396,372; xml: 627,523; asm: 438,677; java: 186,156; sh: 63,477; makefile: 19,171; objc: 13,059; perl: 12,983; yacc: 4,583; cs: 3,846; pascal: 3,405; lex: 1,720; ruby: 1,003; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 53; csh: 10
file content (31 lines) | stat: -rw-r--r-- 813 bytes parent folder | download | duplicates (16) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
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:

.. 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.