Introduce Compose ktlint rules (#267)

build.gradle

@@ -56,11 +56,17 @@ allprojects {
 	spotless {
 		kotlin {
 			target("src/**/*.kt")
-			ktlint(libs.ktlint.get().version).editorConfigOverride([
+			ktlint(libs.ktlint.core.get().version)
-				'ktlint_standard_filename': 'disabled',
+				.editorConfigOverride([
-				'ktlint_standard_property-naming': 'disabled',
+					'ktlint_standard_filename': 'disabled',
-				'ktlint_function_naming_ignore_when_annotated_with': 'Composable',
+					'ktlint_standard_property-naming': 'disabled',
-			])
+					'ktlint_function_naming_ignore_when_annotated_with': 'Composable',
+					'ktlint_compose_modifier-missing-check': 'disabled',
+					'ktlint_compose_compositionlocal-allowlist': 'disabled',
+				])
+				.customRuleSets([
+					libs.ktlint.composeRules.get().toString(),
+				])
 		}
 	}
 }

gradle/libs.versions.toml

@@ -18,7 +18,8 @@ buildconfig-gradlePlugin = "com.github.gmazzo.buildconfig:plugin:4.2.0"
 poko-gradlePlugin = "dev.drewhamilton.poko:poko-gradle-plugin:0.15.1"
 
 spotless-gradlePlugin = "com.diffplug.spotless:spotless-plugin-gradle:6.23.2"
-ktlint = "com.pinterest.ktlint:ktlint-cli:1.0.1"
+ktlint-core = "com.pinterest.ktlint:ktlint-cli:1.0.1"
+ktlint-composeRules = "io.nlopez.compose.rules:ktlint:0.3.3"
 
 jansi = "org.fusesource.jansi:jansi:2.4.1"
 mordant = "com.github.ajalt.mordant:mordant:2.2.0"

mosaic-runtime/src/commonMain/kotlin/com/jakewharton/mosaic/layout/Node.kt

@@ -99,7 +99,7 @@ internal class MosaicNode(
 	override var parentData: Any? = null
 		private set
 
-	var modifiers: Modifier = Modifier
+	var modifier: Modifier = Modifier
 		set(value) {
 			topLayer = value.foldOut(bottomLayer) { element, lowerLayer ->
 				when (element) {

mosaic-runtime/src/commonMain/kotlin/com/jakewharton/mosaic/ui/Box.kt

@@ -28,7 +28,7 @@ public fun Box(
 	val measurePolicy = rememberBoxMeasurePolicy(contentAlignment, propagateMinConstraints)
 	Layout(
 		content = { BoxScopeInstance.content() },
-		modifiers = modifier,
+		modifier = modifier,
 		debugInfo = { "Box(alignment=$contentAlignment, propagateMinConstraints=$propagateMinConstraints)" },
 		measurePolicy = measurePolicy,
 	)

mosaic-runtime/src/commonMain/kotlin/com/jakewharton/mosaic/ui/Column.kt

@@ -20,7 +20,7 @@ public fun Column(
 	val measurePolicy = columnMeasurePolicy(verticalArrangement, horizontalAlignment)
 	Layout(
 		content = { ColumnScopeInstance.content() },
-		modifiers = modifier,
+		modifier = modifier,
 		debugInfo = { "Column(arrangement=$verticalArrangement, alignment=$horizontalAlignment)" },
 		measurePolicy = measurePolicy,
 	)

mosaic-runtime/src/commonMain/kotlin/com/jakewharton/mosaic/ui/Layout.kt

@@ -37,15 +37,16 @@ internal sealed class NoContentMeasureScope {
 
 @Composable
 @MosaicComposable
+@Suppress("ktlint:compose:param-order-check") // Order is correct, check just can't tell.
 internal fun Layout(
-	modifiers: Modifier = Modifier,
+	modifier: Modifier = Modifier,
 	debugInfo: () -> String = { "Layout()" },
 	measurePolicy: NoContentMeasurePolicy,
 ) {
 	Node(
 		measurePolicy = NoContentMeasurePolicyMeasurePolicy(measurePolicy),
-		modifiers = modifiers,
+		modifier = modifier,
-		debugPolicy = { debugInfo() + " x=$x y=$y w=$width h=$height${modifiers.toDebugString()}" },
+		debugPolicy = { debugInfo() + " x=$x y=$y w=$width h=$height${modifier.toDebugString()}" },
 		factory = NodeFactory,
 	)
 }
@@ -63,20 +64,21 @@ private class NoContentMeasurePolicyMeasurePolicy(
 }
 
 @Composable
+@Suppress("ktlint:compose:param-order-check") // Order is what we want.
 public fun Layout(
 	content: @Composable () -> Unit,
-	modifiers: Modifier = Modifier,
+	modifier: Modifier = Modifier,
 	debugInfo: () -> String = { "Layout()" },
 	measurePolicy: MeasurePolicy,
 ) {
 	Node(
 		content = content,
 		measurePolicy = measurePolicy,
-		modifiers = modifiers,
+		modifier = modifier,
 		debugPolicy = {
 			buildString {
 				append(debugInfo())
-				append(" x=$x y=$y w=$width h=$height${modifiers.toDebugString()}")
+				append(" x=$x y=$y w=$width h=$height${modifier.toDebugString()}")
 				children.joinTo(this, separator = "") {
 					"\n" + it.toString().prependIndent("  ")
 				}

mosaic-runtime/src/commonMain/kotlin/com/jakewharton/mosaic/ui/Node.kt

@@ -14,11 +14,12 @@ import com.jakewharton.mosaic.ui.unit.Constraints
 
 @Composable
 @MosaicComposable
+@Suppress("ktlint") // TODO why doesn't "ktlint:compose:param-order-check" work here?
 internal inline fun Node(
 	content:
 	@Composable @MosaicComposable
 	() -> Unit = {},
-	modifiers: Modifier,
+	modifier: Modifier,
 	measurePolicy: MeasurePolicy,
 	debugPolicy: DebugPolicy,
 	noinline factory: () -> MosaicNode,
@@ -27,7 +28,7 @@ internal inline fun Node(
 		factory = factory,
 		update = {
 			set(measurePolicy) { this.measurePolicy = measurePolicy }
-			set(modifiers) { this.modifiers = modifiers }
+			set(modifier) { this.modifier = modifier }
 			set(debugPolicy) { this.debugPolicy = debugPolicy }
 		},
 		content = content,

mosaic-runtime/src/commonMain/kotlin/com/jakewharton/mosaic/ui/Row.kt

@@ -20,7 +20,7 @@ public fun Row(
 	val measurePolicy = rowMeasurePolicy(horizontalArrangement, verticalAlignment)
 	Layout(
 		content = { RowScopeInstance.content() },
-		modifiers = modifier,
+		modifier = modifier,
 		debugInfo = { "Row(arrangement=$horizontalArrangement, alignment=$verticalAlignment)" },
 		measurePolicy = measurePolicy,
 	)

mosaic-runtime/src/commonMain/kotlin/com/jakewharton/mosaic/ui/Spacer.kt

@@ -17,11 +17,11 @@ import com.jakewharton.mosaic.ui.unit.Constraints
  */
 @Composable
 @NonRestartableComposable
-public fun Spacer(modifier: Modifier) {
+public fun Spacer(modifier: Modifier = Modifier) {
 	Layout(
 		content = EmptySpacerContent,
 		measurePolicy = SpacerMeasurePolicy,
-		modifiers = modifier,
+		modifier = modifier,
 		debugInfo = { "Spacer()" },
 	)
 }

mosaic-runtime/src/commonMain/kotlin/com/jakewharton/mosaic/ui/Static.kt

@@ -44,7 +44,7 @@ public fun <T> Static(
 				}
 			}
 		},
-		modifiers = Modifier,
+		modifier = Modifier,
 		debugPolicy = {
 			children.joinToString(prefix = "Static()") { "\n" + it.toString().prependIndent("  ") }
 		},

mosaic-runtime/src/commonMain/kotlin/com/jakewharton/mosaic/ui/Text.kt

@@ -31,7 +31,7 @@ public fun Text(
 			layout.measure()
 			layout(layout.width, layout.height)
 		},
-		modifiers = modifier.drawBehind {
+		modifier = modifier.drawBehind {
 			layout.lines.forEachIndexed { row, line ->
 				drawText(row, 0, line, color, background, style)
 			}
@@ -59,7 +59,7 @@ public fun Text(
 			layout.measure()
 			layout(layout.width, layout.height)
 		},
-		modifiers = modifier.drawBehind {
+		modifier = modifier.drawBehind {
 			layout.lines.forEachIndexed { row, line ->
 				drawText(row, 0, line, color, background, style)
 			}

mosaic-runtime/src/commonTest/kotlin/com/jakewharton/mosaic/DebugRenderingTest.kt

@@ -27,7 +27,7 @@ class DebugRenderingTest {
 		val nodes = mosaicNodes {
 			Row {
 				Text("Hello ")
-				Layout(modifiers = Modifier.drawBehind { throw UnsupportedOperationException() }) {
+				Layout(modifier = Modifier.drawBehind { throw UnsupportedOperationException() }) {
 					layout(5, 1)
 				}
 			}

mosaic-runtime/src/commonTest/kotlin/com/jakewharton/mosaic/LayoutTest.kt

@@ -105,7 +105,7 @@ class LayoutTest {
 				Row {
 					Text("..")
 					Layout(
-						modifiers = Modifier.drawBehind {
+						modifier = Modifier.drawBehind {
 							repeat(4) { row ->
 								drawText(row, 0, "XXXX")
 							}

samples/jest/src/main/kotlin/example/jest.kt

@@ -2,7 +2,6 @@ package example
 
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.LaunchedEffect
-import androidx.compose.runtime.derivedStateOf
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateListOf
 import androidx.compose.runtime.mutableStateOf
@@ -150,9 +149,8 @@ fun Log(complete: SnapshotStateList<Test>) {
 }
 
 @Composable
-fun Status(tests: List<Test>) {
+fun Status(tests: SnapshotStateList<Test>) {
-	val running by derivedStateOf { tests.filter { it.state == Running } }
+	val running = tests.filter { it.state == Running }
-
 	if (running.isNotEmpty()) {
 		for (test in running) {
 			TestRow(test)
@@ -163,8 +161,8 @@ fun Status(tests: List<Test>) {
 }
 
 @Composable
-private fun Summary(totalTests: Int, tests: List<Test>) {
+private fun Summary(totalTests: Int, tests: SnapshotStateList<Test>) {
-	val counts by derivedStateOf { tests.groupingBy { it.state }.eachCount() }
+	val counts = tests.groupingBy { it.state }.eachCount()
 	val failed = counts[Fail] ?: 0
 	val passed = counts[Pass] ?: 0
 	val running = counts[Running] ?: 0
@@ -179,39 +177,41 @@ private fun Summary(totalTests: Int, tests: List<Test>) {
 		}
 	}
 
-	Text(
+	Column {
-		buildAnnotatedString {
+		Text(
-			append("Tests: ")
+			buildAnnotatedString {
+				append("Tests: ")
 
-			if (failed > 0) {
+				if (failed > 0) {
-				withStyle(SpanStyle(color = Red)) {
+					withStyle(SpanStyle(color = Red)) {
-					append("$failed failed")
+						append("$failed failed")
+					}
+					append(", ")
 				}
-				append(", ")
-			}
 
-			if (passed > 0) {
+				if (passed > 0) {
-				withStyle(SpanStyle(color = Green)) {
+					withStyle(SpanStyle(color = Green)) {
-					append("$passed passed")
+						append("$passed passed")
+					}
+					append(", ")
 				}
-				append(", ")
-			}
 
-			if (running > 0) {
+				if (running > 0) {
-				withStyle(SpanStyle(color = Yellow)) {
+					withStyle(SpanStyle(color = Yellow)) {
-					append("$running running")
+						append("$running running")
+					}
+					append(", ")
 				}
-				append(", ")
-			}
 
-			append("$totalTests total")
+				append("$totalTests total")
-		},
+			},
-	)
+		)
 
-	Text("Time:  ${elapsed}s")
+		Text("Time:  ${elapsed}s")
 
-	if (running > 0) {
+		if (running > 0) {
-		TestProgress(totalTests, passed, failed, running)
+			TestProgress(totalTests, passed, failed, running)
+		}
 	}
 }