Group Spotless-specific configuration

Author: gpunto

README.md

@@ -34,14 +34,16 @@ streamProject {
     // Repository name for GitHub URLs and license headers (default: project name)
     repositoryName = "stream-chat-android"
 
-    // Choose formatter (default: false = ktlint)
-    useKtfmt = false
+    spotless {
+        // Choose formatter (default: false = ktlint)
+        useKtfmt = false
 
-    // Exclude specific modules from Spotless formatting (default: empty)
-    spotlessIgnoredModules = setOf("some-module")
+        // Exclude specific modules from Spotless formatting (default: empty)
+        ignoredModules = setOf("some-module")
 
-    // Exclude file patterns from Spotless formatting (default: empty)
-    spotlessExcludePatterns = setOf("**/generated/**", "**/proto/**")
+        // Exclude file patterns from Spotless formatting (default: empty)
+        excludePatterns = setOf("**/generated/**")
+    }
 }
 ```
 

plugin/src/main/kotlin/io/getstream/android/StreamConventionExtensions.kt

@@ -15,15 +15,15 @@
  */
 package io.getstream.android
 
+import io.getstream.android.spotless.SpotlessOptions
 import javax.inject.Inject
+import org.gradle.api.Action
 import org.gradle.api.Project
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.Property
-import org.gradle.api.provider.SetProperty
 import org.gradle.kotlin.dsl.create
 import org.gradle.kotlin.dsl.findByType
 import org.gradle.kotlin.dsl.property
-import org.gradle.kotlin.dsl.setProperty
 
 /**
  * Extension for configuring Stream project-wide settings. Apply the `io.getstream.project` plugin
@@ -37,16 +37,11 @@ constructor(project: Project, objects: ObjectFactory) {
     val repositoryName: Property<String> =
         objects.property<String>().convention(project.provider { project.rootProject.name })
 
-    /** Whether to apply ktfmt formatting instead of ktlint to Kotlin files. Default: false */
-    val useKtfmt: Property<Boolean> = objects.property<Boolean>().convention(false)
+    /** Spotless formatting configuration */
+    val spotless: SpotlessOptions = objects.newInstance(SpotlessOptions::class.java)
 
-    /** Modules to exclude from Spotless formatting. Default: none */
-    val spotlessIgnoredModules: SetProperty<String> =
-        objects.setProperty<String>().convention(emptySet())
-
-    /** File patterns to exclude from Spotless formatting beyond build files. Default: none */
-    val spotlessExcludePatterns: SetProperty<String> =
-        objects.setProperty<String>().convention(emptySet())
+    /** Configure Spotless formatting settings */
+    fun spotless(action: Action<SpotlessOptions>) = action.execute(spotless)
 }
 
 internal fun Project.createProjectExtension(): StreamProjectExtension =

plugin/src/main/kotlin/io/getstream/android/StreamConventionPlugins.kt

@@ -18,6 +18,7 @@ package io.getstream.android
 import com.android.build.api.dsl.ApplicationExtension
 import com.android.build.api.dsl.LibraryExtension
 import com.android.build.api.dsl.TestExtension
+import io.getstream.android.spotless.configureSpotless
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 

plugin/src/main/kotlin/io/getstream/android/SpotlessConfiguration.kt renamed to plugin/src/main/kotlin/io/getstream/android/spotless/SpotlessConfiguration.kt

@@ -13,14 +13,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package io.getstream.android
+package io.getstream.android.spotless
 
 import com.diffplug.gradle.spotless.SpotlessExtension
+import io.getstream.android.GenerateLicenseFileTask
+import io.getstream.android.requireStreamProjectExtension
 import org.gradle.api.Project
 import org.gradle.api.Task
 import org.gradle.api.tasks.TaskContainer
 import org.gradle.kotlin.dsl.configure
-import org.gradle.kotlin.dsl.findByType
 import org.gradle.kotlin.dsl.named
 import org.gradle.kotlin.dsl.register
 
@@ -33,15 +34,15 @@ internal fun Project.configureSpotless() {
         val projectExtension = requireStreamProjectExtension()
 
         // Check if Spotless should be disabled for this module
-        if (name in projectExtension.spotlessIgnoredModules.get()) {
+        if (name in projectExtension.spotless.ignoredModules.get()) {
             return@afterEvaluate
         }
 
         val repositoryName =
             projectExtension.repositoryName.orNull
                 ?: error("streamProject.repositoryName must be configured in the root project")
 
-        val useKtfmt = projectExtension.useKtfmt.get()
+        val useKtfmt = projectExtension.spotless.useKtfmt.get()
 
         val generateKotlinLicenseTask =
             registerLicenseGenerationTask(
@@ -68,7 +69,7 @@ internal fun Project.configureSpotless() {
                 target("**/*.kt")
                 targetExclude("**/build/**/*.kt")
 
-                projectExtension.spotlessExcludePatterns.orNull
+                projectExtension.spotless.excludePatterns.orNull
                     ?.takeUnless(Set<String>::isEmpty)
                     ?.let { patterns -> targetExclude(*patterns.toTypedArray()) }
 

plugin/src/main/kotlin/io/getstream/android/spotless/SpotlessOptions.kt

@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2014-2025 Stream.io Inc. All rights reserved.
+ *
+ * Licensed under the Stream License;
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    https://github.com/GetStream/stream-build-conventions-android/blob/main/LICENSE
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.getstream.android.spotless
+
+import javax.inject.Inject
+import org.gradle.api.model.ObjectFactory
+import org.gradle.api.provider.Property
+import org.gradle.api.provider.SetProperty
+import org.gradle.kotlin.dsl.property
+import org.gradle.kotlin.dsl.setProperty
+
+abstract class SpotlessOptions @Inject constructor(objects: ObjectFactory) {
+
+    /** Whether to apply ktfmt formatting instead of ktlint to Kotlin files. Default: false */
+    val useKtfmt: Property<Boolean> = objects.property<Boolean>().convention(false)
+
+    /** Modules to exclude from Spotless formatting. Default: none */
+    val ignoredModules: SetProperty<String> = objects.setProperty<String>().convention(emptySet())
+
+    /** File patterns to exclude from Spotless formatting beyond build files. Default: none */
+    val excludePatterns: SetProperty<String> = objects.setProperty<String>().convention(emptySet())
+}