Google Git
Sign in
android / platform / prebuilts / checkstyle / 0635407dd0f45292142086e7cf1535a94639510d
commit0635407dd0f45292142086e7cf1535a94639510d[log] [tgz]
authorSam Saccone <samccone@google.com>Fri Jul 10 19:03:12 2020 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Fri Jul 10 19:03:12 2020 +0000
treec23cde41453e9697481fe3452b8d791da9bfba38
parentf97db17303caf83e43793bfa4667563938d02aaf [diff]
parent018bec4e5c5fd5fa595155a88e02dbd94144352b [diff]
[automerger skipped] Migrate from blame to history scoped blame am: adef809ab8 am: c2fc52cc78 -s ours am: 55d6ed27a6 -s ours am: 018bec4e5c -s ours

am skip reason: Change-Id I2c020aa64264834135f2b17f0c8a4a274bfd13bd with SHA-1 f3179e7578 is in history

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

Change-Id: I75d0342239fe99c0990599c95a800fb90c5d9732
tree: c23cde41453e9697481fe3452b8d791da9bfba38
  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.