Google Git
Sign in
android / platform / prebuilts / checkstyle / a719b60de236f0228c47462cbaef128e474c1544
commita719b60de236f0228c47462cbaef128e474c1544[log] [tgz]
authorSorin Basca <sorinbasca@google.com>Tue Sep 26 15:10:32 2023 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Tue Sep 26 15:10:32 2023 +0000
tree7492f4736ae3a748b63fd655eb41053964ce8f2d
parenta50ab0fb641f13280b043c816f31a5d6d7e8dc4a [diff]
parentd92d09899e292c46cd7290412f4474d6db8acb41 [diff]
[automerger skipped] Allow missing javadoc for tests am: d92d09899e -s ours

am skip reason: Merged-In Ic7ee2f841dea15cdd6da1716a5bf26cbda697327 with SHA-1 5b129846c5 is already in history

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

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