Google Git
Sign in
android / platform / prebuilts / checkstyle / 42ef477f7b16e8083a7316df70cae946e731b8f5
commit42ef477f7b16e8083a7316df70cae946e731b8f5[log] [tgz]
authorMakoto Onuki <[email protected]>Tue May 21 23:03:01 2024 +0000
committerAutomerger Merge Worker <[email protected]>Tue May 21 23:03:01 2024 +0000
treec56089069e4000e07c279b9c941d51ff7ec5645f
parent0cb2b61e504926ec1c14043b3275f5433b4c1a45 [diff]
parent7071470e066ca89beaed4b1a91fb706158e9bd3a [diff]
Allow "$ravenwood" to be a method name suffix am: 7071470e06

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

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