Implement M2ApiDetector #75
Conversation
This implements an opt-in check that can be used to error against use of M2 APIs. This is intended to be useful for apps that have completed their M3 migrations or baseline existing M2 usages while completing their migrations.
|
I haven't added tests yet as I want to get early feedback on the approach before I move ahead with those! |
| """, | ||
| category = CORRECTNESS, | ||
| priority = NORMAL, | ||
| severity = IGNORE, |
There was a problem hiding this comment.
informational? I think it's worth highlighting even if devs don't want to make it an error.
There was a problem hiding this comment.
I think I generally agree. Do you know if M2 is ever going to be fully deprecated?
There was a problem hiding this comment.
Ah good point. We need to think about teams who are using M2 and don't want to migrate yet. We should probably add some docs to copy-pasta for changing the severity level?
Or maybe just link to https://developer.android.com/studio/write/lint#gradle
|
|
||
| override fun createUastHandler(context: JavaContext) = | ||
| object : UElementHandler() { | ||
| override fun visitCallExpression(node: UCallExpression) = checkNode(node) |
There was a problem hiding this comment.
Will the call expression contain the package name? It wouldn't in ktlint, but I guess it will in Lint? If so, I say we don't check the imports.
Having this handle imports means that devs have to use @file:SuppressLint to suppress the import warnings, and they're annoying 😆
There was a problem hiding this comment.
when you call resolve on the UCallExpression, it returns the called function and we check the package name of that function.
Agreed on imports. May be a no-go since I don't think you can use file site target with @SuppressLint 🤔. I'll check
There was a problem hiding this comment.
You can for Kotlin @Suppress but I don't think I've ever tried it for SuppressLint
There was a problem hiding this comment.
yah you can't since it's in the android jar itself. Remove imports 88b5bf1
docs/rules.md
Outdated
|
|
||
| Material 3 (M3) reached stable in October 2022. In apps that have migrated to M3, there may be `androidx.compose.material` (M2) APIs still remaining on the classpath from libraries or dependencies that can cause confusing imports due to the many similar or colliding Composable names in the two libraries. The `ComposeM2Api` can be enabled + set to `ERROR` to prevent these from being used. | ||
|
|
||
| Note that this rule is set to `IGNORE` by default and is opt-in. |
There was a problem hiding this comment.
Ditto severity comment above
Co-authored-by: Chris Banes <chrisbanes@users.noreply.github.com>
|
@chrisbanes should be ready to go now, added tests and spruced up docs more |
great work!
This implements an opt-in check that can be used to error against use of M2 APIs. This is intended to be useful for apps that have completed their M3 migrations or baseline existing M2 usages while completing their migrations.