Google Git
Sign in
android / platform / prebuilts / checkstyle / cce7820ae987bc0f2cf13f9515bac850843b326e
commitcce7820ae987bc0f2cf13f9515bac850843b326e[log] [tgz]
authorandroid-build-team Robot <android-build-team-robot@google.com>Thu Dec 19 04:20:50 2019 +0000
committerandroid-build-team Robot <android-build-team-robot@google.com>Thu Dec 19 04:20:50 2019 +0000
tree3992f37ad1add81d15f9fe61659815f11f9dc22b
parentb5ba0671a265baaa0ba23945b3a0748988d729e3 [diff]
parent1b95dd79828e47667dddc60190b209b3e521254d [diff]
Snap for 6084815 from 1b95dd79828e47667dddc60190b209b3e521254d to rvc-release

Change-Id: Ib5441e9b1f869bdf460c758cf857ddc0aa16a8f1
tree: 3992f37ad1add81d15f9fe61659815f11f9dc22b
  1. gitlint/
  2. .gitignore
  3. android-style.xml
  4. checkstyle.jar
  5. checkstyle.py
  6. default-copyright-check.xml
  7. default-javadoc-checks.xml
  8. default-module-checks.xml
  9. default-treewalker-checks.xml
  10. LICENSE
  11. OWNERS
  12. PREUPLOAD.cfg
  13. README.md
  14. tests.py
README.md

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.