https://github.com/guilhermekrz/CustomAndroidLint

Custom Android Lint Rules
https://github.com/guilhermekrz/CustomAndroidLint

android android-development lint

Last synced: 2 months ago
JSON representation

Custom Android Lint Rules

• Host: GitHub
• URL: https://github.com/guilhermekrz/CustomAndroidLint
• Owner: guilhermekrz
• Created: 2020-05-29T21:38:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-03-21T17:00:11.000Z (almost 4 years ago)
• Last Synced: 2024-08-03T18:20:01.735Z (6 months ago)
• Topics: android, android-development, lint
• Language: Kotlin
• Homepage:
• Size: 165 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Custom Lint Rules

## Current rules

* [Method should not declare more than 5 parameters](https://medium.com/@guilhermekrz/how-to-implement-your-first-custom-lint-rule-in-android-using-tdd-part-1-d3c9a58a7aa8)

* [Should only construct OkHttpClient once](https://medium.com/@guilhermekrz/how-to-implement-a-custom-lint-rule-in-android-that-requires-an-overall-view-of-the-project-part-34f1371cf0c3)

* [Do not throw Exception from Kotlin code (either by annotating the method as @Throws or by actually throwing a new Exception)](https://medium.com/@guilhermekrz/how-to-implement-a-custom-lint-rule-in-android-to-warn-against-checked-exception-thrown-from-a076eb9fecd5)

* Detect if Java code throws and Kotlin code does not catch

* Detect if you are setting the fragment manager before calling Activity onCreate method

## Ideas

* [Detect if we are using immutable list/set/map and Java needs a mutable list/set/map](https://groups.google.com/g/lint-dev/c/qgBbBkY4Wng)

## Resources

* Android Lint API Guide: https://googlesamples.github.io/android-custom-lint-rules/book.md.html

* Android Official Lint Doc: https://developer.android.com/studio/write/lint

* Android Official Sample: https://github.com/googlesamples/android-custom-lint-rules

* All of Android lint checks are available at https://android.googlesource.com/platform/tools/base/+/master/lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks

* Initial code based on https://github.com/fabiocarballo/lint-sample

* Other custom lint rules:

    * https://www.bignerdranch.com/blog/building-custom-lint-checks-in-android/

    * https://jayrambhia.com/blog/android-lint and https://jayrambhia.com/blog/android-lint-ref

    * https://proandroiddev.com/enforcing-clean-architecture-using-android-custom-lint-rules-aa8fc1708c59

    * https://medium.com/supercharges-mobile-product-guide/formatting-code-analysis-rule-with-android-lint-part-1-2-4b906f717382

    * https://medium.com/@sinankozak/android-lint-rule-for-immutable-kotlin-data-classes-5c91517c7611