Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/twisterrob/android-lint-examples
Project that reproduces every lint violation out there. (At least that's the idea, contributions welcome.)
https://github.com/twisterrob/android-lint-examples
android android-development lint static-analysis static-code-analysis
Last synced: 3 months ago
JSON representation
Project that reproduces every lint violation out there. (At least that's the idea, contributions welcome.)
- Host: GitHub
- URL: https://github.com/twisterrob/android-lint-examples
- Owner: TWiStErRob
- License: unlicense
- Created: 2019-02-10T12:38:37.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T22:25:52.000Z (4 months ago)
- Last Synced: 2024-10-20T21:39:04.337Z (4 months ago)
- Topics: android, android-development, lint, static-analysis, static-code-analysis
- Language: Java
- Homepage: https://github.com/TWiStErRob/android-lint-examples
- Size: 697 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Security: Security/EasterEgg/build.gradle
Awesome Lists containing this project
README
Project that reproduces every lint violation out there.
_See [`settings.gradle`](settings.gradle) for list of lint checks added in the project._
Goals
-----
* simple examples demonstrating each and every Lint check violation
* modules focused on single Lint check
* get every possible report for each check
(each execution path in detectors, see [CONTRIBUTING.md](docs/CONTRIBUTING.md#Coverage))
* discover bugs in `lint`
(flagged with `REPORT` or `REPORTED` comments, see [CONTRIBUTING.md](docs/CONTRIBUTING.md#Documentation))
Warning
-------
**This project is not meant to show good practices, quite the opposite, code is written intentionally badly to reproduce specific Lint check violations.**
That being said, I strive to use best practices and style whenever possible. Code that's not related to the lint check violation should be the best possible. For example supporting code (like `build.gradle`s) were written with best intentions.
Examples one should almost never do in production:
* Blindly suppress a Lint warning as "irrelevant"
_I did it here to focus on a specific issue. Rest assured, there are other modules which violate those checks too._
* Uppercase Gradle module names
_I chose to use non-standard naming so that it's extremely clear which module deals with what lint check. It also allows to automate easily (see how `lintOptions` and `lintVerifyCount` is set up)._
* Uppercase Java/Kotlin package names
_I chose to use non-standard naming to have the check name occur in the module as text with exact text casing._
Setup & Debugging
-----------------
See [instructions](docs/DEVELOPMENT.md)
Reading
-------
* What is lint? What does it do?
http://tools.android.com/lint/overview
* What lint version belongs to what Android Gradle Plugin version?
There seems to be a correspondence: `23.0.0 + `.
e.g. AGP 3.0.0 = lint 26.0.0, AGP 3.3.2 = lint 26.3.2
* List of lint checks with explanation
http://tools.android.com/tips/lint-checks
```shell
lint --show
```
See [`docs/lint/show (version).txt`](docs/lint).
* List of lint checks (concise)
```shell
lint --list
```
See [`docs/lint/list (version).txt`](docs/lint).
* lint source code tests
[platform/tools/base/+/studio-master-dev/lint/libs/lint-tests](https://android.googlesource.com/platform/tools/base/+/studio-master-dev/lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks)
* List of lint checks supported by Android Studio 3.3.1
[`.idea/inspectionProfiles/Project_Default.xml`](.idea/inspectionProfiles/Project_Default.xml)
* Lint categories (based on `lint-checks-26.0.0-dev.jar`)
```shell
lint --show | grep 'Category:' | uniq --count | sort --reverse
# Windows with grep and uniq helpers from cpp-w64devkit:
lint --show | grep "Category:" | uniq -c | sort /R
```
See [`docs/lint/categories (version).txt`](docs/lint).