Google Git
Sign in
android / platform / prebuilts / checkstyle / 5656e34e01814da69263ec0e9d99d19d352a060e
commit5656e34e01814da69263ec0e9d99d19d352a060e[log] [tgz]
authorJeremy Bettis <[email protected]>Mon Dec 09 21:52:48 2024 +0000
committerAutomerger Merge Worker <[email protected]>Mon Dec 09 21:52:48 2024 +0000
treed9e1fce6ba732cd30714dbebf520f1f2cb505c90
parentcf98c774bbb4d744834587b7c6cd3ab2e2bfd708 [diff]
parentd19e2b543fe2537e223f10dcbe350f55f952b2da [diff]
Add de to import groups am: d19e2b543f

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

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