Publicly usable lint checks (#1427)

firestore/build.gradle.kts

@@ -24,6 +24,8 @@ dependencies {
 
     compileOnly(Config.Libs.Arch.paging)
 
+    lintChecks(project(":lint"))
+
     androidTestImplementation(Config.Libs.Test.junit)
     androidTestImplementation(Config.Libs.Test.runner)
     androidTestImplementation(Config.Libs.Test.rules)

internal/lint/build.gradle.kts

@@ -12,6 +12,6 @@ dependencies {
 
 tasks.withType<Jar>().configureEach {
     manifest {
-        attributes(mapOf("Lint-Registry-v2" to "com.firebaseui.lint.LintIssueRegistry"))
+        attributes(mapOf("Lint-Registry-v2" to "com.firebaseui.lint.internal.LintIssueRegistry"))
     }
 }

internal/lint/src/main/java/com/firebaseui/lint/internal/LintIssueRegistry.kt

@@ -0,0 +1,12 @@
+package com.firebaseui.lint.internal
+
+import com.android.tools.lint.client.api.IssueRegistry
+
+/**
+ * Registry for custom FirebaseUI lint checks.
+ */
+class LintIssueRegistry : IssueRegistry() {
+    override val issues = listOf(
+        NonGlobalIdDetector.NON_GLOBAL_ID
+    )
+}

internal/lint/src/main/java/com/firebaseui/lint/NonGlobalIdDetector.kt → internal/lint/src/main/java/com/firebaseui/lint/internal/NonGlobalIdDetector.kt

@@ -1,4 +1,4 @@
-package com.firebaseui.lint
+package com.firebaseui.lint.internal
 
 import com.android.tools.lint.detector.api.Category
 import com.android.tools.lint.detector.api.Implementation

internal/lint/src/test/java/com/firebaseui/lint/NonGlobalIdDetectorTest.kt → internal/lint/src/test/java/com/firebaseui/lint/internal/NonGlobalIdDetectorTest.kt

@@ -1,11 +1,25 @@
-package com.firebaseui.lint
+package com.firebaseui.lint.internal
 
 import com.android.tools.lint.checks.infrastructure.TestFiles.xml
-import com.firebaseui.lint.LintTestHelper.configuredLint
-import com.firebaseui.lint.NonGlobalIdDetector.Companion.NON_GLOBAL_ID
+import com.android.tools.lint.checks.infrastructure.TestLintTask
+import com.firebaseui.lint.internal.NonGlobalIdDetector.Companion.NON_GLOBAL_ID
 import org.junit.Test
+import java.io.File
 
 class NonGlobalIdDetectorTest {
+
+    // Nasty hack to make lint tests pass on Windows. For some reason, lint doesn't
+    // automatically find the Android SDK in its standard path on Windows. This hack looks
+    // through the system properties to find the path defined in `local.properties` and then
+    // sets lint's SDK home to that path if it's found.
+    private val sdkPath = System.getProperty("java.library.path").split(';').find {
+        it.contains("SDK", true)
+    }
+
+    fun configuredLint(): TestLintTask = TestLintTask.lint().apply {
+        sdkHome(File(sdkPath ?: return@apply))
+    }
+
     @Test
     fun `Passes on valid view id`() {
         configuredLint()

lint/build.gradle.kts

@@ -0,0 +1,17 @@
+plugins {
+    id("kotlin")
+}
+
+dependencies {
+    compileOnly(Config.Libs.Lint.api)
+    compileOnly(Config.Libs.Kotlin.jvm)
+
+    testImplementation(Config.Libs.Lint.api)
+    testImplementation(Config.Libs.Lint.tests)
+}
+
+ tasks.withType<Jar>().configureEach {
+     manifest {
+         attributes(mapOf("Lint-Registry-v2" to "com.firebaseui.lint.LintIssueRegistry"))
+     }
+ }

internal/lint/src/main/java/com/firebaseui/lint/LintIssueRegistry.kt → lint/src/main/java/com/firebaseui/lint/LintIssueRegistry.kt

@@ -7,8 +7,7 @@ import com.android.tools.lint.client.api.IssueRegistry
  */
 class LintIssueRegistry : IssueRegistry() {
     override val issues = listOf(
-        NonGlobalIdDetector.NON_GLOBAL_ID,
-        FirestoreRecyclerAdapterLifecycleDetector.ISSUE_MISSING_LISTENING_START_METHOD,
-        FirestoreRecyclerAdapterLifecycleDetector.ISSUE_MISSING_LISTENING_STOP_METHOD
+            FirestoreRecyclerAdapterLifecycleDetector.ISSUE_MISSING_LISTENING_START_METHOD,
+            FirestoreRecyclerAdapterLifecycleDetector.ISSUE_MISSING_LISTENING_STOP_METHOD
     )
 }

internal/lint/src/test/java/com/firebaseui/lint/FirestoreRecyclerAdapterLifecycleDetectorTest.kt → lint/src/test/java/com/firebaseui/lint/FirestoreRecyclerAdapterLifecycleDetectorTest.kt

@@ -1,13 +1,26 @@
 package com.firebaseui.lint
 
 import com.android.tools.lint.checks.infrastructure.TestFiles.java
+import com.android.tools.lint.checks.infrastructure.TestLintTask
 import com.firebaseui.lint.FirestoreRecyclerAdapterLifecycleDetector.Companion.ISSUE_MISSING_LISTENING_START_METHOD
 import com.firebaseui.lint.FirestoreRecyclerAdapterLifecycleDetector.Companion.ISSUE_MISSING_LISTENING_STOP_METHOD
-import com.firebaseui.lint.LintTestHelper.configuredLint
 import org.junit.Test
+import java.io.File
 
 class FirestoreRecyclerAdapterLifecycleDetectorTest {
 
+  // Nasty hack to make lint tests pass on Windows. For some reason, lint doesn't
+  // automatically find the Android SDK in its standard path on Windows. This hack looks
+  // through the system properties to find the path defined in `local.properties` and then
+  // sets lint's SDK home to that path if it's found.
+  private val sdkPath = System.getProperty("java.library.path").split(';').find {
+    it.contains("SDK", true)
+  }
+
+  fun configuredLint(): TestLintTask = TestLintTask.lint().apply {
+     sdkHome(File(sdkPath ?: return@apply))
+  }
+
   @Test
   fun `Checks missing startListening() method call`() {
     configuredLint()

proguard-tests/build.gradle.kts

@@ -4,6 +4,11 @@ android {
     }
 
     buildTypes {
+        named("debug").configure {
+            // This empty config is only here to make Android Studio happy.
+            // This build type is later ignored in the variantFilter section
+        }
+
         named("release").configure {
             // For the purposes of the sample, allow testing of a proguarded release build
             // using the debug key

settings.gradle.kts

@@ -5,5 +5,8 @@ include(
         ":common", ":firestore", ":database",
         ":storage",
 
+
+        ":lint",
+
         ":proguard-tests", ":internal:lint", ":internal:lintchecks"
 )