Google Git
Sign in
android / platform / prebuilts / checkstyle / 27f7deb7e7f6f9ed6262e20ae38aa2247e28b96d
commit27f7deb7e7f6f9ed6262e20ae38aa2247e28b96d[log] [tgz]
authorXin Li <delphij@google.com>Sat Feb 20 13:53:45 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Sat Feb 20 13:53:45 2021 +0000
treec78d9fbd5d784dd9d3a79c9cfd1bd0c10b33dbb8
parent5d6e474cf48a3c0a3d19357226830d6a9427ce8b [diff]
parent585ddf8b6bd33258e0304567a700e0024961e419 [diff]
[automerger skipped] Mark ab/7061308 as merged in stage. am: 86287ba819 -s ours am: 585ddf8b6b -s ours

am skip reason: Change-Id If12ffe9f83fef4bdb4e7edc24ac28d03455a0982 with SHA-1 7139009abd is in history

Original change: undetermined

MUST ONLY BE SUBMITTED BY AUTOMERGER

Change-Id: I052b7044edc0f3d2c07966e21ee351aa04acd0b5
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.