Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/heads/main
commit8531c66bf9a4439e7050dae3d447d42ae0b383e3[log] [tgz]
authorDavid Saff <[email protected]>Tue Dec 10 20:11:21 2024 +0000
committerAutomerger Merge Worker <[email protected]>Tue Dec 10 20:11:21 2024 +0000
treede5c03188e48e986db481206ba7b4774ea37c62f
parent5656e34e01814da69263ec0e9d99d19d352a060e [diff]
parent5b8d0f2d74b08567d6b33d70cc4389d57e9b18c1 [diff]
Add `platform` to checkstyle import order am: 5b8d0f2d74

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

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