Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / prebuilts / checkstyle / 833b585503ee9403f4358e05a4143770c5ed0464
commit833b585503ee9403f4358e05a4143770c5ed0464[log] [tgz]
authorLuca Stefani <luca.stefani.ge1@gmail.com>Wed Feb 01 17:40:36 2023 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>Wed Feb 01 17:40:36 2023 +0000
tree166094d4ece2cbfb7eb3adbcc2987f0ef0f7bfbf
parentfd988c15302ded7109388dd80456ae282ccaef82 [diff]
parente90d24ee812c1689c08f38f3aad0697aedf585f1 [diff]
[automerger skipped] gitlint: Fix string concatenation am: 06cc0c6dc1 am: e32591e065 -s ours am: 38344443b1 -s ours am: f49628401d -s ours am: 7784c94249 -s ours am: 708403e15a -s ours am: e90d24ee81 -s ours

am skip reason: Merged-In Iaa0b2e047a7f859831b203533c96071d819ef3d1 with SHA-1 9f2a68c00b is already in history

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

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