Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/heads/main
commite60e1e1cba6f02fe153164cd5544f1c82d14a801[log] [tgz]
authorOwner Cleanup Bot <swarming-tasks@owners-cleanup-prod.google.com.iam.gserviceaccount.com>Tue Feb 25 15:38:15 2025 -0800
committerAutomerger Merge Worker <[email protected]>Tue Feb 25 15:38:15 2025 -0800
treecaf2eb3074ab6fc74987016a341c569b0e9adef2
parent61af02426c30a74734352e4af5eed26c95f2abc6 [diff]
parente73ec688325c938d38b1e5ba8419a5784de2a9a7 [diff]
[owners] Remove [email protected] from OWNERS am: e73ec68832

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

Change-Id: Id401e7839cfff5207ca4033ed9e9bb9bea165fad
Signed-off-by: Automerger Merge Worker <[email protected]>
tree: caf2eb3074ab6fc74987016a341c569b0e9adef2
  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.