Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/platform-tools-33.0.0
tag07d481dc046e4bfc594b83129848a084d0c19a95
taggerThe Android Open Source Project <initial-contribution@android.com>Thu May 19 16:15:36 2022 -0700
object1a32c01eb9a82f5cc66c847f87a1c9a027f1bdfa 
Platform Tools Release 33.0.0 (8141338)
commit1a32c01eb9a82f5cc66c847f87a1c9a027f1bdfa[log] [tgz]
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Thu Dec 16 00:07:20 2021 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>Thu Dec 16 00:07:20 2021 +0000
treeba998044a2b63dd8119c505e0870f764c35ede8e
parent2347d9b1a54c30f6868f10ac4340507560d1b8fa [diff]
parentf0a750481a570030eba0792f8969e05b915d08d6 [diff]
Snap for 8005954 from f0a750481a570030eba0792f8969e05b915d08d6 to sdk-release

Change-Id: I66d5ac8382e2ea1bf38b7f5106b21f40d26109a0
tree: ba998044a2b63dd8119c505e0870f764c35ede8e
  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.