Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/platform-tools-30.0.5
tagdcd9427fa6f49c88f86d2998a5aca5f0e76c4889
taggerThe Android Open Source Project <initial-contribution@android.com>Wed Nov 04 12:15:23 2020 -0800
object30e7b896779644c2e4cb7a71d84bf734a2ab8217 
Platform Tools Release 30.0.5 (6877874)
commit30e7b896779644c2e4cb7a71d84bf734a2ab8217[log] [tgz]
authorandroid-build-prod (mdb) <android-build-team-robot@google.com>Thu Oct 01 20:25:04 2020 +0000
committerandroid-build-prod (mdb) <android-build-team-robot@google.com>Thu Oct 01 20:25:04 2020 +0000
treed23c11abff6ec562d0b6bf17274f239af51c3b49
parentb9616d0aba6b2c66b35189d5d4ff46b8adef6a58 [diff]
parent9a3581ccecbb8918131aee21ed5553f2de9da043 [diff]
Snap for 6877830 from 9a3581ccecbb8918131aee21ed5553f2de9da043 to sdk-release

Change-Id: I913ddd721da07b0fa1e88233aa7a91f60204b793
tree: d23c11abff6ec562d0b6bf17274f239af51c3b49
  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.