feat: introduce spotless/ktlint

.editorconfig

@@ -0,0 +1,28 @@
+root = true
+
+[*]
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{kt,kts}]
+ij_kotlin_imports_layout = *
+ij_kotlin_allow_trailing_comma = true
+ij_kotlin_allow_trailing_comma_on_call_site = true
+ij_kotlin_line_break_after_multiline_when_entry = false
+ij_kotlin_name_count_to_use_star_import = 2147483647
+ij_kotlin_name_count_to_use_star_import_for_members = 2147483647
+ij_kotlin_packages_to_use_import_on_demand = unset
+ktlint_code_style = intellij_idea
+ktlint_function_naming_ignore_when_annotated_with = Composable
+ktlint_standard_function-expression-body = disabled
+ktlint_standard_filename = disabled
+ktlint_compose_modifier-missing-check = disabled
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.xml]
+indent_size = 4

.github/workflows/spotless.yaml

@@ -0,0 +1,27 @@
+name: Spotless Check
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  spotless:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Set up JDK
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: gradle
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x ./gradlew
+
+      - name: Run Spotless Check
+        run: ./gradlew spotlessCheck

build.gradle.kts

@@ -1,3 +1,5 @@
+import com.diffplug.gradle.spotless.SpotlessExtension
+
 plugins {
   // this is necessary to avoid the plugins to be loaded multiple times
   // in each subproject's classloader
@@ -8,6 +10,7 @@ plugins {
   alias(libs.plugins.compose.compiler) apply false
   alias(libs.plugins.kotlin.jvm) apply false
   alias(libs.plugins.dokka) apply false
+  alias(libs.plugins.spotless) apply false
 }
 
 subprojects {
@@ -28,8 +31,27 @@ subprojects {
       }
     }
   }
+  plugins.apply(rootProject.libs.plugins.spotless.get().pluginId)
+  extensions.configure<SpotlessExtension> {
+    kotlin {
+      target("src/**/*.kt")
+      targetExclude("src/test/resources/**")
+      ktlint(libs.ktlint.get().version)
+        .editorConfigOverride(
+          mapOf(
+            "ktlint_compose_modifier-missing-check" to "disabled",
+            "ktlint_compose_compositionlocal-allowlist" to "disabled",
+          ),
+        )
+        .customRuleSets(listOf(libs.composeRules.get().toString()))
+    }
+    kotlinGradle {
+      ktlint(libs.ktlint.get().version)
+    }
+  }
 }
 
 inline fun <reified T> Project.configureIfExists(fn: T.() -> Unit) {
   extensions.findByType(T::class.java)?.fn()
-}
+}
+

examples/build.gradle.kts

@@ -40,7 +40,7 @@ kotlin {
   listOf(
     iosX64(),
     iosArm64(),
-    iosSimulatorArm64()
+    iosSimulatorArm64(),
   ).forEach { iosTarget ->
     iosTarget.binaries.framework {
       baseName = "ComposeApp"

examples/src/androidMain/kotlin/Platform.android.kt

@@ -4,4 +4,4 @@ class AndroidPlatform : Platform {
   override val name: String = "Android ${Build.VERSION.SDK_INT}"
 }
 
-actual fun getPlatform(): Platform = AndroidPlatform()
+actual fun getPlatform(): Platform = AndroidPlatform()

examples/src/androidMain/kotlin/org/jetbrains/storytale/example/MainActivity.kt

@@ -19,6 +19,6 @@ class MainActivity : ComponentActivity() {
 
 @Preview
 @Composable
-fun AppAndroidPreview() {
+private fun AppAndroidPreview() {
   App()
-}
+}

examples/src/commonMain/kotlin/App.kt

@@ -1,28 +1,36 @@
+
 import androidx.compose.animation.AnimatedVisibility
 import androidx.compose.foundation.layout.Column
 import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.size
 import androidx.compose.material.MaterialTheme
 import androidx.compose.material.Text
-import androidx.compose.runtime.*
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.remember
+import androidx.compose.runtime.setValue
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
-import org.jetbrains.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.dp
 
 @Composable
-@Preview
-fun App() {
+fun App(modifier: Modifier = Modifier) {
   var showContent by remember { mutableStateOf(false) }
 
   MaterialTheme {
-    Column(Modifier.fillMaxWidth(), horizontalAlignment = Alignment.CenterHorizontally) {
+    Column(
+      modifier = modifier.fillMaxWidth(),
+      horizontalAlignment = Alignment.CenterHorizontally,
+    ) {
       PrimaryButton(text = "Click Me", onClick = { showContent = !showContent })
       AnimatedVisibility(showContent) {
         val greeting = remember { Greeting().greet() }
         Column(Modifier.fillMaxWidth(), horizontalAlignment = Alignment.CenterHorizontally) {
-          ComposeLogo()
+          ComposeLogo(Modifier.size(600.dp))
           Text("Compose: $greeting")
         }
       }
     }
   }
-}
+}