Integrate Jetpack Compose Lint Checks

https://github.com/slackhq/compose-lints
chrisbanes · Feb 20, 2023 · a75f08e · a75f08e
1 parent 0f9ed6b
commit a75f08e
Show file tree

Hide file tree

Showing 16 changed files with 74 additions and 1 deletion.
diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -203,6 +203,8 @@ dependencies {
     implementation(libs.compose.animation.animation)
     implementation(libs.compose.ui.tooling)
 
+    lintChecks(libs.slack.lint.compose)
+
     implementation(libs.accompanist.navigation.animation)
     implementation(libs.accompanist.navigation.material)
 

diff --git a/common/ui/compose/build.gradle.kts b/common/ui/compose/build.gradle.kts
@@ -32,6 +32,10 @@ android {
     composeOptions {
         kotlinCompilerExtensionVersion = libs.versions.composecompiler.get()
     }
+
+    lint {
+        baseline = file("lint-baseline.xml")
+    }
 }
 
 dependencies {
@@ -60,4 +64,6 @@ dependencies {
     implementation(libs.androidx.paging.compose)
 
     implementation(libs.coil.compose)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/common/ui/compose/lint-baseline.xml b/common/ui/compose/lint-baseline.xml
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<issues format="6" by="lint 8.0.0-beta02" type="baseline" client="gradle" dependencies="false" name="AGP (8.0.0-beta02)" variant="all" version="8.0.0-beta02">
+
+    <issue
+        id="ComposeParameterOrder"
+        message="Parameters in a composable function should be ordered following this pattern: params without defaults, modifiers, params with defaults and optionally, a trailing function that might not have a default param.&#xA;Current params are: [title: @Composable () -> Unit, modifier: Modifier = Modifier, navigationIcon: @Composable () -> Unit, bottomContent: @Composable (() -> Unit)? = null, actions: @Composable RowScope.() -> Unit = {}, containerColor: Color = MaterialTheme.colorScheme.surface, contentColor: Color = contentColorFor(containerColor), elevation: Dp = 0.dp] but should be [title: @Composable () -> Unit, navigationIcon: @Composable () -> Unit, modifier: Modifier = Modifier, bottomContent: @Composable (() -> Unit)? = null, actions: @Composable RowScope.() -> Unit = {}, containerColor: Color = MaterialTheme.colorScheme.surface, contentColor: Color = contentColorFor(containerColor), elevation: Dp = 0.dp].&#xA;See https://slackhq.github.io/compose-lints/rules/#ordering-composable-parameters-properly for more information."
+        errorLine1="/**"
+        errorLine2="^">
+        <location
+            file="src/main/java/app/tivi/common/compose/ui/AppBar.kt"
+            line="39"
+            column="1"/>
+    </issue>
+
+    <issue
+        id="ComposeUnstableCollections"
+        message="The Compose Compiler cannot infer the stability of a parameter if a List&lt;SortOption> is used in it, even if the item type is stable.&#xA;You should use Kotlinx Immutable Collections instead: `sortOptions: ImmutableList&lt;SortOption>` or create an `@Immutable` wrapper for this class: `@Immutable data class SortOptionsList(val items: List&lt;SortOption>)`&#xA;See https://slackhq.github.io/compose-lints/rules/#avoid-using-unstable-collections for more information."
+        errorLine1="    sortOptions: List&lt;SortOption>,"
+        errorLine2="                 ~~~~~~~~~~~~~~~~">
+        <location
+            file="src/main/java/app/tivi/common/compose/ui/SortChip.kt"
+            line="43"
+            column="18"/>
+    </issue>
+
+    <issue
+        id="ComposeUnstableCollections"
+        message="The Compose Compiler cannot infer the stability of a parameter if a List&lt;SortOption> is used in it, even if the item type is stable.&#xA;You should use Kotlinx Immutable Collections instead: `sortOptions: ImmutableList&lt;SortOption>` or create an `@Immutable` wrapper for this class: `@Immutable data class SortOptionsList(val items: List&lt;SortOption>)`&#xA;See https://slackhq.github.io/compose-lints/rules/#avoid-using-unstable-collections for more information."
+        errorLine1="    sortOptions: List&lt;SortOption>,"
+        errorLine2="                 ~~~~~~~~~~~~~~~~">
+        <location
+            file="src/main/java/app/tivi/common/compose/ui/SortMenuPopup.kt"
+            line="32"
+            column="18"/>
+    </issue>
+
+</issues>
diff --git a/common/ui/compose/src/main/java/app/tivi/common/compose/ui/IconButtonScrim.kt b/common/ui/compose/src/main/java/app/tivi/common/compose/ui/IconButtonScrim.kt
@@ -34,10 +34,14 @@ import app.tivi.common.compose.theme.TiviTheme
 fun ScrimmedIconButton(
     showScrim: Boolean,
     onClick: () -> Unit,
+    modifier: Modifier = Modifier,
     invertThemeOnScrim: Boolean = true,
     icon: @Composable () -> Unit,
 ) {
-    IconButton(onClick = onClick) {
+    IconButton(
+        onClick = onClick,
+        modifier = modifier,
+    ) {
         if (invertThemeOnScrim) {
             val isLight = MaterialTheme.colorScheme.surface.luminance() > 0.5
 

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -142,6 +142,8 @@ retrofit-mock = { module = "com.squareup.retrofit2:retrofit-mock", version.ref =
 
 robolectric = "org.robolectric:robolectric:4.9.2"
 
+slack-lint-compose = "com.slack.lint.compose:compose-lint-checks:1.0.1"
+
 swipe = "me.saket.swipe:swipe:1.1.1"
 
 store = "org.mobilenativefoundation.store:store5:5.0.0-alpha03"

diff --git a/ui/account/build.gradle.kts b/ui/account/build.gradle.kts
@@ -59,4 +59,6 @@ dependencies {
     implementation(libs.coil.compose)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/discover/build.gradle.kts b/ui/discover/build.gradle.kts
@@ -52,4 +52,6 @@ dependencies {
     implementation(libs.compose.ui.tooling)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/episode/details/build.gradle.kts b/ui/episode/details/build.gradle.kts
@@ -56,4 +56,6 @@ dependencies {
     implementation(libs.coil.compose)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/episode/track/build.gradle.kts b/ui/episode/track/build.gradle.kts
@@ -56,4 +56,6 @@ dependencies {
     implementation(libs.coil.compose)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/library/build.gradle.kts b/ui/library/build.gradle.kts
@@ -59,4 +59,6 @@ dependencies {
     implementation(libs.coil.compose)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/popular/build.gradle.kts b/ui/popular/build.gradle.kts
@@ -52,4 +52,6 @@ dependencies {
     implementation(libs.compose.ui.tooling)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/recommended/build.gradle.kts b/ui/recommended/build.gradle.kts
@@ -52,4 +52,6 @@ dependencies {
     implementation(libs.compose.ui.tooling)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/search/build.gradle.kts b/ui/search/build.gradle.kts
@@ -52,4 +52,6 @@ dependencies {
     implementation(libs.compose.ui.tooling)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/show/details/build.gradle.kts b/ui/show/details/build.gradle.kts
@@ -53,4 +53,6 @@ dependencies {
     implementation(libs.coil.compose)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/show/seasons/build.gradle.kts b/ui/show/seasons/build.gradle.kts
@@ -54,4 +54,6 @@ dependencies {
     implementation(libs.coil.compose)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }
diff --git a/ui/trending/build.gradle.kts b/ui/trending/build.gradle.kts
@@ -52,4 +52,6 @@ dependencies {
     implementation(libs.compose.ui.tooling)
 
     ksp(libs.kotlininject.compiler)
+
+    lintChecks(libs.slack.lint.compose)
 }