Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/android-12.0.0_r31
tag082f82def97e0786a52fba266693e325d484a669
taggerThe Android Open Source Project <initial-contribution@android.com>Mon Feb 07 16:35:23 2022 -0800
object9a1120705f2d9c38fd95fdfba7147c6a03e82e2a 
Android 12.0.0 Release 31 (SP1A.210812.016.C1)
commit9a1120705f2d9c38fd95fdfba7147c6a03e82e2a[log] [tgz]
authorandroid-build-team Robot <android-build-team-robot@google.com>Sat Apr 24 03:09:01 2021 +0000
committerandroid-build-team Robot <android-build-team-robot@google.com>Sat Apr 24 03:09:01 2021 +0000
tree36ad4012de2981dafd8fbf822f7cb716f3f4f09c
parente05b9c6d3fdcb57a3d8f72027857a35fa52251c1 [diff]
parent90d40ed0c7855653d569186f24228c813a642f28 [diff]
Snap for 7310088 from 90d40ed0c7855653d569186f24228c813a642f28 to sc-release

Change-Id: I151b9aef6433872eba516be56caf379b54679e8c
tree: 36ad4012de2981dafd8fbf822f7cb716f3f4f09c
  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.