Google Git
Sign in
android / platform / prebuilts / checkstyle / 791cb7569dac505534227e73c30f203dcdce0903
commit791cb7569dac505534227e73c30f203dcdce0903[log] [tgz]
authorXin Li <delphij@google.com>Fri Oct 09 03:37:00 2020 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Fri Oct 09 03:37:00 2020 +0000
treed23c11abff6ec562d0b6bf17274f239af51c3b49
parent1b04f4123619f66fc3e1df177ccd2ed6a8dccfba [diff]
parent6b6dceffe4522520313f9893c11003c8d2e69934 [diff]
[automerger skipped] Skip ab/6749736 in stage. am: bc96dc054b -s ours am: bab0889bc2 -s ours am: 6b6dceffe4 -s ours

am skip reason: Change-Id I8dd8d66f16dfc10b981532f1e7052893d7185957 with SHA-1 36c21817c7 is in history

Original change: https://googleplex-android-review.googlesource.com/c/platform/prebuilts/checkstyle/+/12797212

Change-Id: I6a9aee9ef24e33950ecb13354c5bfb1e0529674c
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.