Clone this repo:
  1. 4ebbfec Add support for python3 by Luca Stefani · 12 days ago master
  2. b770c45 DO NOT MERGE - qt-qpr1-dev-plus-aosp-without-vendor@5915889 into stage-aosp-master by Xin Li · 4 months ago androidx-sqlite-release android-r-preview-1
  3. eed98a3 Adding Pre-upload instructions to checkstyle README am: 153a9a100e am: 7d6bb91e31 am: de2842a0f4 by Hayden Gomes · 6 months ago
  4. 8db5f2c Adding Pre-upload instructions to checkstyle README am: 153a9a100e am: 7d6bb91e31 by Hayden Gomes · 6 months ago androidx-annotation-annotation-experimental-release androidx-benchmark-release androidx-browser-release androidx-localbroadcastmanager-release
  5. de2842a Adding Pre-upload instructions to checkstyle README am: 153a9a100e by Hayden Gomes · 6 months ago

Checkstyle

Checkstyle is used by developers to validate Java code style and formatting, and can be run as part of the pre-upload hooks.

Running it

It can be invoked in two ways.

  1. To check style of entire specific files: checkstyle.py -f FILE [FILE ...]
  2. To check style of the lines modified in the latest commit: checkstyle.py

Projects used

Checkstyle

A development tool to help programmers write Java code that adheres to a coding standard.

Git-Lint

Git-lint is a tool to run lint checks on only files changed in the latest commit.

  • URL: https://github.com/sk-/git-lint/
  • Version: 0.0.8
  • License: Apache 2.0
  • License File: gitlint/LICENSE
  • Local Modifications:
    • Downloaded gitlint/git.py and git/utils.py files individually.

Pre-upload linting

To run checkstyle as part of the pre-upload hooks, add the following line to your PREUPLOAD.cfg:

checkstyle_hook = ${REPO_ROOT}/prebuilts/checkstyle/checkstyle.py --sha ${PREUPLOAD_COMMIT}

Note that checkstyle does not always agree with clang-format, and so it's best to only have one enabled for Java.

Disabling Clang Format for Java

In .clang-format add the following to disable format checking and correcting for Java:

---
Language: Java
DisableFormat: true
SortIncludes: false
---

In some versions of clang-format, DisableFormat doesn't stop the sorting of includes. So to fully disable clang-format from doing anything for Java files, both options are needed.