Google Git
Sign in
android / platform / prebuilts / checkstyle / refs/heads/androidx-test-uiautomator-release
commitcbc1b8eda862ba707d62aeb235c8cf9d5664ca13[log] [tgz]
authorTom Bergan <tombergan@google.com>Tue Oct 10 00:48:53 2023 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Tue Oct 10 00:48:53 2023 +0000
treee497b2f785443b62b4b2d661995bb1d1322a8f0f
parentb46154b689537912032d88cfdd74ff718ca812d8 [diff]
parent3aef040bddc89081a1df5a5a9398a617f9aecf53 [diff]
checkstyle: add junitparams to ImportOrder am: 9dc8c43529 am: a4d4710aba am: b0f0ccc65a am: 3aef040bdd

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

Change-Id: Ic47f42ce9b8f514f1cf40ef1f40474799c1656db
Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
tree: e497b2f785443b62b4b2d661995bb1d1322a8f0f
  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.