Google Git
Sign in
android / platform / prebuilts / checkstyle / 3f50707630846b24adcfaf1efb62b24aa6e4fec7
commit3f50707630846b24adcfaf1efb62b24aa6e4fec7[log] [tgz]
authorEmber Rose <emberrose@google.com>Thu Oct 28 22:29:40 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Thu Oct 28 22:29:40 2021 +0000
treeba998044a2b63dd8119c505e0870f764c35ede8e
parentc4be839bcf73475fb119c26729c255c1f38f1f71 [diff]
parentf77cc58458a6520befe8c43344cf3c7a1638d0fa [diff]
Update hashbangs to python3 am: 54a6f9175a am: f0a750481a am: 3a3ad8b952 am: f77cc58458

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

Change-Id: I05fcb21c72072842a894579039412d784ba7989a
tree: ba998044a2b63dd8119c505e0870f764c35ede8e
  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.