Google Git
Sign in
android / platform / prebuilts / checkstyle / 845415df234f383c633e0fc3f907ba5de5817118
commit845415df234f383c633e0fc3f907ba5de5817118[log] [tgz]
authorXin Li <delphij@google.com>Fri Sep 11 03:58:41 2020 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Fri Sep 11 03:58:41 2020 +0000
treed23c11abff6ec562d0b6bf17274f239af51c3b49
parent7a9ee0f2e9d2ac23033b5ce32a5218588abc9539 [diff]
parent7f87ef555592ae9fa2304e180fefc34725bbb77e [diff]
[automerger skipped] Merge Android R am: 9a3581ccec -s ours am: a0c8263eee -s ours am: 67113da08b -s ours am: 7f87ef5555 -s ours

am skip reason: Change-Id Ie91fd6a281f5e9ccb814a86ab1b18ea44564d427 with SHA-1 be2900434e is in history

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

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