Google Git
Sign in
android / platform / prebuilts / checkstyle / eed98a3e6b5edc56ba915ca24f462c1419f6fd7f
commiteed98a3e6b5edc56ba915ca24f462c1419f6fd7f[log] [tgz]
authorHayden Gomes <haydengomes@google.com>Fri Aug 16 17:43:47 2019 -0700
committerandroid-build-merger <android-build-merger@google.com>Fri Aug 16 17:43:47 2019 -0700
treeda7f6725407d4ece9fd372ce4ce8406d5dade979
parent03087a617bfe55f862cb1ef43273a2bd08e8b6d6 [diff]
parent8db5f2c6ac87e8c6ef41c826c3387851c4565f5f [diff]
Adding Pre-upload instructions to checkstyle README am: 153a9a100e am: 7d6bb91e31 am: de2842a0f4
am: 8db5f2c6ac

Change-Id: Ie54d07a7a43da9581e35b2d2c7800be1c85e1db9
tree: da7f6725407d4ece9fd372ce4ce8406d5dade979
  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.