Google Git
Sign in
android / platform / prebuilts / checkstyle / 510970323118b5f7f130d7f2d2bdb07dcef408e3
commit510970323118b5f7f130d7f2d2bdb07dcef408e3[log] [tgz]
authorKirit <kirit@google.com>Sat Jun 24 00:09:04 2023 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Sat Jun 24 00:09:04 2023 +0000
treeefb478c7662c7dcd6832184fe8ffdeeae4382100
parentaa2a8a69631ccb2ec254a7496224b02a2a07fdf0 [diff]
parent1a766eabdd731849450594d91462658d6e6b7c6f [diff]
[automerger skipped] checkstyle: add io to ImportOrder am: 4375d671a2 am: 6c6674f72e am: bfc5d04a7b -s ours am: 1a766eabdd -s ours

am skip reason: Merged-In Iae54e301ea5a96711896c24632231a2c776606df with SHA-1 73d4b46272 is already in history

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

Change-Id: I27a2c3cb5a34e0b6c7373cfd3caf4bbb8d0e2041
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
tree: efb478c7662c7dcd6832184fe8ffdeeae4382100
  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.