Implement M2ApiDetector

compose-lint-checks/src/main/java/slack/lint/compose/ComposeLintsIssueRegistry.kt

@@ -31,6 +31,7 @@ class ComposeLintsIssueRegistry : IssueRegistry() {
       ModifierMissingDetector.ISSUE,
       ModifierReusedDetector.ISSUE,
       ModifierWithoutDefaultDetector.ISSUE,
+      M2ApiDetector.ISSUE,
       MultipleContentEmittersDetector.ISSUE,
       MutableParametersDetector.ISSUE,
       ParameterOrderDetector.ISSUE,

compose-lint-checks/src/main/java/slack/lint/compose/M2ApiDetector.kt

@@ -0,0 +1,70 @@
+// Copyright (C) 2022 Salesforce, Inc.
+// SPDX-License-Identifier: Apache-2.0
+package slack.lint.compose
+
+import com.android.tools.lint.client.api.UElementHandler
+import com.android.tools.lint.detector.api.Category.Companion.CORRECTNESS
+import com.android.tools.lint.detector.api.Detector
+import com.android.tools.lint.detector.api.Issue
+import com.android.tools.lint.detector.api.JavaContext
+import com.android.tools.lint.detector.api.Severity.IGNORE
+import com.android.tools.lint.detector.api.SourceCodeScanner
+import com.android.tools.lint.detector.api.TextFormat
+import org.jetbrains.uast.UCallExpression
+import org.jetbrains.uast.UElement
+import org.jetbrains.uast.UImportStatement
+import org.jetbrains.uast.UQualifiedReferenceExpression
+import org.jetbrains.uast.UResolvable
+import slack.lint.compose.util.Priorities.NORMAL
+import slack.lint.compose.util.sourceImplementation
+
+internal class M2ApiDetector : Detector(), SourceCodeScanner {
+
+  override fun getApplicableUastTypes() =
+    listOf<Class<out UElement>>(
+      UCallExpression::class.java,
+      UImportStatement::class.java,
+      UQualifiedReferenceExpression::class.java,
+    )
+
+  override fun createUastHandler(context: JavaContext) =
+    object : UElementHandler() {
+      override fun visitCallExpression(node: UCallExpression) = checkNode(node)
+
+      override fun visitImportStatement(node: UImportStatement) = checkNode(node)
+
+      override fun visitQualifiedReferenceExpression(node: UQualifiedReferenceExpression) =
+        checkNode(node)
+
+      private fun checkNode(node: UResolvable) {
+        val resolved = node.resolve() ?: return
+        val packageName = context.evaluator.getPackage(resolved)?.qualifiedName ?: return
+        if (packageName == M2Package) {
+          context.report(
+            issue = ISSUE,
+            location = context.getLocation(node),
+            message = ISSUE.getExplanation(TextFormat.TEXT),
+          )
+        }
+      }
+    }
+
+  companion object {
+    private const val M2Package = "androidx.compose.material"
+
+    val ISSUE =
+      Issue.create(
+        id = "ComposeM2Api",
+        briefDescription = "Using a Compose M2 API is not recommended",
+        explanation =
+          """
+          Compose Material 2 (M2) is succeeded by Material 3 (M3). Please use M3 APIs.
+          See https://slackhq.github.io/compose-lints/rules/#use-material-3 for more information.
+        """,
+        category = CORRECTNESS,
+        priority = NORMAL,
+        severity = IGNORE,
+        implementation = sourceImplementation<M2ApiDetector>()
+      )
+  }
+}

docs/rules.md

@@ -294,3 +294,22 @@ Composed modifiers may be created outside of composition, shared across elements
 More info: [Modifier extensions](https://developer.android.com/reference/kotlin/androidx/compose/ui/package-summary#extension-functions), [Composed modifiers in Jetpack Compose by Jorge Castillo](https://jorgecastillo.dev/composed-modifiers-in-jetpack-compose) and [Composed modifiers in API guidelines](https://github.com/androidx/androidx/blob/androidx-main/compose/docs/compose-api-guidelines.md#composed-modifiers)
 
 Related rule: [`ComposeComposableModifier`](https://github.com/slackhq/compose-lints/blob/main/compose-lint-checks/src/main/java/slack/lint/compose/ModifierComposableDetector.kt)
+
+### Use Material 3
+
+Rule: [`ComposeM2Api`](https://github.com/slackhq/compose-lints/blob/main/compose-lint-checks/src/main/java/slack/lint/compose/M2ApiDetector.kt)
+
+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.
+
+
+**Related docs links**
+
+- Announcement post: https://material.io/blog/material-3-compose-stable
+- Docs: https://m3.material.io/develop/android/jetpack-compose
+- Migration guide: https://developer.android.com/jetpack/compose/themes/material2-material3
+- Guidance: https://developer.android.com/jetpack/compose/themes/material3
+- Reply (primary sample app): https://github.com/android/compose-samples/tree/main/Reply
+- More samples: https://github.com/android/compose-samples
+