Google Git
Sign in
android / platform / prebuilts / checkstyle / c354fa6c87fb8d4b9f1a90d4dd31a2505cf08c33
commitc354fa6c87fb8d4b9f1a90d4dd31a2505cf08c33[log] [tgz]
authorXin Li <delphij@google.com>Tue Apr 30 02:10:29 2024 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Tue Apr 30 02:10:29 2024 +0000
tree155230ea8546c495dc76833b84e04962c698270b
parent412954fb3de120c0eea0a42e717dd86fef9ac5d2 [diff]
parent0cb2b61e504926ec1c14043b3275f5433b4c1a45 [diff]
[automerger skipped] Empty merge of Android 24Q2 Release (ab/11526283) to aosp-main-future am: 0cb2b61e50 -s ours

am skip reason: Merged-In I58fa0ebf949378b1b25434300298588bb969d80d with SHA-1 a6a08173f0 is already in history

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

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