Google Git
Sign in
android / platform / prebuilts / checkstyle / 86287ba819d07bcd43493948ee6393de31f85f36
commit86287ba819d07bcd43493948ee6393de31f85f36[log] [tgz]
authorXin Li <delphij@google.com>Sat Feb 20 00:24:37 2021 -0800
committerXin Li <delphij@google.com>Sat Feb 20 00:24:37 2021 -0800
treec78d9fbd5d784dd9d3a79c9cfd1bd0c10b33dbb8
parent24930308bb18feb7ad5b307a02f905b141f8cfba [diff]
parent7139009abdd15bfd58cd49d02f84d58ff03ae285 [diff]
Mark ab/7061308 as merged in stage.

Bug: 180401296
Merged-In: If12ffe9f83fef4bdb4e7edc24ac28d03455a0982
Change-Id: Icd3d2d1f98a3333bef18432113a1391f30e20551
tree: c78d9fbd5d784dd9d3a79c9cfd1bd0c10b33dbb8
  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.