Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/android-12.1.0_r20
taga02c98145e82abb8ca59d1564d61b1390040ef01
taggerThe Android Open Source Project <initial-contribution@android.com>Tue Aug 02 10:54:07 2022 -0700
object90d40ed0c7855653d569186f24228c813a642f28 
Android 12.1.0 release 20
commit90d40ed0c7855653d569186f24228c813a642f28[log] [tgz]
authorCole Faust <colefaust@google.com>Fri Apr 23 18:57:34 2021 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Fri Apr 23 18:57:34 2021 +0000
tree36ad4012de2981dafd8fbf822f7cb716f3f4f09c
parent27f7deb7e7f6f9ed6262e20ae38aa2247e28b96d [diff]
parent76c0a542919858eebeb547cf0e1c9b1c221889c9 [diff]
Make checkstyle allow long javadoc links am: 7fa0660d59 am: 836568c6b0 am: 76c0a54291

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

Change-Id: I30e7b7c0101935237b7562e2b11c8c05fb9d0653
tree: 36ad4012de2981dafd8fbf822f7cb716f3f4f09c
  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.