Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/tags/t_frc_ase_330444010
tag689e57c18c9bdbf1d2c6b3a62eb35a025023e653
taggerThe Android Open Source Project <initial-contribution@android.com>Tue Sep 20 02:54:01 2022 -0700
objectfd988c15302ded7109388dd80456ae282ccaef82 
Android Mainline Module Release 8998604,com.google.android.appsearch
commitfd988c15302ded7109388dd80456ae282ccaef82[log] [tgz]
authorAurimas Liutikas <aurimas@google.com>Fri Mar 18 08:10:50 2022 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Fri Mar 18 08:10:50 2022 +0000
tree166094d4ece2cbfb7eb3adbcc2987f0ef0f7bfbf
parent1d74a2fb270d001b84f669b42b8704e325a5532d [diff]
parent7618fd3dd0606c75611022eca09b514ef36cdc3b [diff]
Add jvmTest to know list of test directories am: 6b2c40c903 am: d70d12e041 am: 7618fd3dd0

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

Change-Id: I75443e1548eb838e55ef139a55af947a0d2ef7d9
tree: 166094d4ece2cbfb7eb3adbcc2987f0ef0f7bfbf
  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.