From dacf13ca7f30c00b980cec69507fde5732c259d8 Mon Sep 17 00:00:00 2001
From: Aurimas Liutikas <aurimas@google.com>
Date: Thu, 29 Jan 2026 15:49:27 -0800
Subject: [PATCH] Apply spotless by default

- Upgrades to spotless 8.2.1
- Moves spotless setup from an init.gradle.kts to build-logic
- Narrows down the scope of `target` in spotless configuration to
  be more precise to workaround https://github.com/diffplug/spotless/issues/2717
- Updates all references to init.gradle.kts

Ran gradle-profiler ./gradlew build --dry-run to validate performance
impact.
Before PR:
Mean 10,527.96 ms with 289.01 ms std dev
After PR:
Mean 11,251.78 ms with 530.29 ms std dev

Regression is there, but quite minor.

Test: ./gradlew spotlessCheck
---
 .github/pull_request_template.md              |  2 +-
 .github/workflows/Build.yaml                  |  2 +-
 .run/spotlessApply.run.xml                    |  1 -
 AGENTS.md                                     |  2 +-
 build-logic/convention/build.gradle.kts       |  1 +
 .../AndroidApplicationConventionPlugin.kt     |  2 +
 .../kotlin/AndroidLibraryConventionPlugin.kt  |  2 +
 .../main/kotlin/JvmLibraryConventionPlugin.kt |  2 +
 .../apps/nowinandroid/KotlinAndroid.kt        |  2 +
 .../samples/apps/nowinandroid/Spotless.kt     | 55 +++++++++++++++++
 build.gradle.kts                              |  1 +
 gradle/init.gradle.kts                        | 59 -------------------
 gradle/libs.versions.toml                     |  4 ++
 tools/pre-push                                |  2 +-
 14 files changed, 73 insertions(+), 64 deletions(-)
 create mode 100644 build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/Spotless.kt
 delete mode 100644 gradle/init.gradle.kts

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 265ff2ba5..efe4ef29a 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -10,7 +10,7 @@ Thanks for submitting a pull request. To accept your pull request we need you do
 **Ensure tests pass and code is formatted correctly**
 
 - Run local tests on the `DemoDebug` variant by running `./gradlew testDemoDebug`
-- Fix code formatting: `./gradlew --init-script gradle/init.gradle.kts spotlessApply`
+- Fix code formatting: `./gradlew spotlessApply`
 
 **Add a description**
 
diff --git a/.github/workflows/Build.yaml b/.github/workflows/Build.yaml
index 7e5a80eea..eec554b37 100644
--- a/.github/workflows/Build.yaml
+++ b/.github/workflows/Build.yaml
@@ -48,7 +48,7 @@ jobs:
         run: ./gradlew :build-logic:convention:check
 
       - name: Check spotless
-        run: ./gradlew spotlessCheck --init-script gradle/init.gradle.kts --no-configuration-cache
+        run: ./gradlew spotlessCheck
 
       - name: Check Dependency Guard
         id: dependencyguard_verify
diff --git a/.run/spotlessApply.run.xml b/.run/spotlessApply.run.xml
index 5c4dac833..03bd19a6d 100644
--- a/.run/spotlessApply.run.xml
+++ b/.run/spotlessApply.run.xml
@@ -4,7 +4,6 @@
       <option name="executionName" />
       <option name="externalProjectPath" value="$PROJECT_DIR$" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="--init-script=gradle/init.gradle.kts" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/AGENTS.md b/AGENTS.md
index efb39ef19..edcfd396e 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -26,7 +26,7 @@ The main Android app lives in the `app/` folder. Feature modules live in `featur
 The app and Android libraries have two product flavors: `demo` and `prod`, and two build types: `debug` and `release`.
 
 - Build: `./gradlew assemble{Variant}`. Typically `assembleDemoDebug`.
-- Fix linting/formatting: `./gradlew --init-script gradle/init.gradle.kts spotlessApply`
+- Fix linting/formatting: `./gradlew spotlessApply`
 - Run local tests: `./gradlew {variant}Test`
 - Run single test: `./gradlew {variant}Test --tests "com.example.myapp.MyTestClass"`
 - Run local screenshot tests: `./gradlew verifyRoborazziDemoDebug`
diff --git a/build-logic/convention/build.gradle.kts b/build-logic/convention/build.gradle.kts
index 5faf257c1..41491da4f 100644
--- a/build-logic/convention/build.gradle.kts
+++ b/build-logic/convention/build.gradle.kts
@@ -45,6 +45,7 @@ dependencies {
     compileOnly(libs.kotlin.gradlePlugin)
     compileOnly(libs.ksp.gradlePlugin)
     compileOnly(libs.room.gradlePlugin)
+    compileOnly(libs.spotless.gradlePlugin)
     implementation(libs.truth)
     lintChecks(libs.androidx.lint.gradle)
 }
diff --git a/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt
index 8c45a056c..8cbd06a7c 100644
--- a/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt
+++ b/build-logic/convention/src/main/kotlin/AndroidApplicationConventionPlugin.kt
@@ -20,6 +20,7 @@ import com.google.samples.apps.nowinandroid.configureBadgingTasks
 import com.google.samples.apps.nowinandroid.configureGradleManagedDevices
 import com.google.samples.apps.nowinandroid.configureKotlinAndroid
 import com.google.samples.apps.nowinandroid.configurePrintApksTask
+import com.google.samples.apps.nowinandroid.configureSpotlessForAndroid
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.kotlin.dsl.apply
@@ -42,6 +43,7 @@ class AndroidApplicationConventionPlugin : Plugin<Project> {
                 configurePrintApksTask(this)
                 configureBadgingTasks(this)
             }
+            configureSpotlessForAndroid()
         }
     }
 }
diff --git a/build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt b/build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt
index ee47e823a..045334a49 100644
--- a/build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt
+++ b/build-logic/convention/src/main/kotlin/AndroidLibraryConventionPlugin.kt
@@ -20,6 +20,7 @@ import com.google.samples.apps.nowinandroid.configureFlavors
 import com.google.samples.apps.nowinandroid.configureGradleManagedDevices
 import com.google.samples.apps.nowinandroid.configureKotlinAndroid
 import com.google.samples.apps.nowinandroid.configurePrintApksTask
+import com.google.samples.apps.nowinandroid.configureSpotlessForAndroid
 import com.google.samples.apps.nowinandroid.disableUnnecessaryAndroidTests
 import com.google.samples.apps.nowinandroid.libs
 import org.gradle.api.Plugin
@@ -52,6 +53,7 @@ class AndroidLibraryConventionPlugin : Plugin<Project> {
                 configurePrintApksTask(this)
                 disableUnnecessaryAndroidTests(target)
             }
+            configureSpotlessForAndroid()
             dependencies {
                 "androidTestImplementation"(libs.findLibrary("kotlin.test").get())
                 "testImplementation"(libs.findLibrary("kotlin.test").get())
diff --git a/build-logic/convention/src/main/kotlin/JvmLibraryConventionPlugin.kt b/build-logic/convention/src/main/kotlin/JvmLibraryConventionPlugin.kt
index a1477891d..c9150abc7 100644
--- a/build-logic/convention/src/main/kotlin/JvmLibraryConventionPlugin.kt
+++ b/build-logic/convention/src/main/kotlin/JvmLibraryConventionPlugin.kt
@@ -15,6 +15,7 @@
  */
 
 import com.google.samples.apps.nowinandroid.configureKotlinJvm
+import com.google.samples.apps.nowinandroid.configureSpotlessForJvm
 import com.google.samples.apps.nowinandroid.libs
 import org.gradle.api.Plugin
 import org.gradle.api.Project
@@ -28,6 +29,7 @@ class JvmLibraryConventionPlugin : Plugin<Project> {
             apply(plugin = "nowinandroid.android.lint")
 
             configureKotlinJvm()
+            configureSpotlessForJvm()
             dependencies {
                 "testImplementation"(libs.findLibrary("kotlin.test").get())
             }
diff --git a/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/KotlinAndroid.kt b/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/KotlinAndroid.kt
index 37b1ba99b..6d16efdb7 100644
--- a/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/KotlinAndroid.kt
+++ b/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/KotlinAndroid.kt
@@ -17,10 +17,12 @@
 package com.google.samples.apps.nowinandroid
 
 import com.android.build.api.dsl.CommonExtension
+import com.diffplug.gradle.spotless.SpotlessExtension
 import org.gradle.api.JavaVersion
 import org.gradle.api.Project
 import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.kotlin.dsl.assign
+import org.gradle.kotlin.dsl.apply
 import org.gradle.kotlin.dsl.configure
 import org.gradle.kotlin.dsl.dependencies
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
diff --git a/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/Spotless.kt b/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/Spotless.kt
new file mode 100644
index 000000000..8b92345c5
--- /dev/null
+++ b/build-logic/convention/src/main/kotlin/com/google/samples/apps/nowinandroid/Spotless.kt
@@ -0,0 +1,55 @@
+/*
+ * Copyright 2026 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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 com.google.samples.apps.nowinandroid
+
+import com.diffplug.gradle.spotless.SpotlessExtension
+import org.gradle.api.Project
+import org.gradle.kotlin.dsl.apply
+import org.gradle.kotlin.dsl.configure
+
+internal fun Project.configureSpotlessForAndroid() {
+    configureSpotlessCommon()
+    extensions.configure<SpotlessExtension> {
+        format("xml") {
+            target("src/**/*.xml")
+            // Look for the first XML tag that isn't a comment (<!--) or the xml declaration (<?xml)
+            licenseHeaderFile(rootProject.file("spotless/copyright.xml"), "(<[^!?])")
+        }
+    }
+}
+
+internal fun Project.configureSpotlessForJvm() {
+    configureSpotlessCommon()
+}
+
+private fun Project.configureSpotlessCommon() {
+    apply(plugin = "com.diffplug.spotless")
+    extensions.configure<SpotlessExtension> {
+        kotlin {
+            target("src/**/*.kt")
+            ktlint(libs.findVersion("ktlint").get().requiredVersion).editorConfigOverride(
+                mapOf("android" to "true")
+            )
+            licenseHeaderFile(rootDir.resolve("spotless/copyright.kt"))
+        }
+        format("kts") {
+            target("*.kts")
+            // Look for the first line that doesn't have a block comment (assumed to be the license)
+            licenseHeaderFile(rootDir.resolve("spotless/copyright.kts"), "(^(?![\\/ ]\\*).*$)")
+        }
+    }
+}
\ No newline at end of file
diff --git a/build.gradle.kts b/build.gradle.kts
index 594f7f92e..3096d6bda 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -38,5 +38,6 @@ plugins {
     alias(libs.plugins.roborazzi) apply false
     alias(libs.plugins.google.osslicenses) apply false
     alias(libs.plugins.room) apply false
+    alias(libs.plugins.spotless) apply false
     alias(libs.plugins.nowinandroid.root)
 }
diff --git a/gradle/init.gradle.kts b/gradle/init.gradle.kts
deleted file mode 100644
index 44dc41200..000000000
--- a/gradle/init.gradle.kts
+++ /dev/null
@@ -1,59 +0,0 @@
-/*
- * Copyright 2022 The Android Open Source Project
- *
- *   Licensed under the Apache License, Version 2.0 (the "License");
- *   you may not use this file except in compliance with the License.
- *   You may obtain a copy of the License at
- *
- *       https://www.apache.org/licenses/LICENSE-2.0
- *
- *   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.
- */
-
-val ktlintVersion = "1.4.0"
-
-initscript {
-    val spotlessVersion = "6.25.0"
-
-    repositories {
-        mavenCentral()
-    }
-
-    dependencies {
-        classpath("com.diffplug.spotless:spotless-plugin-gradle:$spotlessVersion")
-    }
-}
-
-rootProject {
-    subprojects {
-        apply<com.diffplug.gradle.spotless.SpotlessPlugin>()
-        extensions.configure<com.diffplug.gradle.spotless.SpotlessExtension> {
-            kotlin {
-                target("**/*.kt")
-                targetExclude("**/build/**/*.kt")
-                ktlint(ktlintVersion).editorConfigOverride(
-                    mapOf(
-                        "android" to "true",
-                    ),
-                )
-                licenseHeaderFile(rootProject.file("spotless/copyright.kt"))
-            }
-            format("kts") {
-                target("**/*.kts")
-                targetExclude("**/build/**/*.kts")
-                // Look for the first line that doesn't have a block comment (assumed to be the license)
-                licenseHeaderFile(rootProject.file("spotless/copyright.kts"), "(^(?![\\/ ]\\*).*$)")
-            }
-            format("xml") {
-                target("**/*.xml")
-                targetExclude("**/build/**/*.xml")
-                // Look for the first XML tag that isn't a comment (<!--) or the xml declaration (<?xml)
-                licenseHeaderFile(rootProject.file("spotless/copyright.xml"), "(<[^!?])")
-            }
-        }
-    }
-}
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
index f6dd9379d..fbe070c1a 100644
--- a/gradle/libs.versions.toml
+++ b/gradle/libs.versions.toml
@@ -51,6 +51,7 @@ kotlinxCoroutines = "1.10.1"
 kotlinxDatetime = "0.6.1"
 kotlinxSerializationJson = "1.8.0"
 ksp = "2.3.4"
+ktlint = "1.4.0"
 okhttp = "4.12.0"
 protobuf = "4.29.2"
 protobufPlugin = "0.9.6"
@@ -59,6 +60,7 @@ retrofitKotlinxSerializationJson = "1.0.0"
 robolectric = "4.16"
 roborazzi = "1.56.0"
 room = "2.8.3"
+spotless = "8.2.1"
 truth = "1.4.4"
 turbine = "1.2.0"
 uiTestJunit4 = "1.9.0-rc01"
@@ -171,6 +173,7 @@ kotlin-gradlePlugin = { group = "org.jetbrains.kotlin", name = "kotlin-gradle-pl
 ksp-gradlePlugin = { group = "com.google.devtools.ksp", name = "com.google.devtools.ksp.gradle.plugin", version.ref = "ksp" }
 room-gradlePlugin = { group = "androidx.room", name = "room-gradle-plugin", version.ref = "room" }
 androidx-compose-ui-test-junit4 = { group = "androidx.compose.ui", name = "ui-test-junit4", version.ref = "uiTestJunit4" }
+spotless-gradlePlugin = { group = "com.diffplug.spotless", name = "spotless-plugin-gradle", version.ref = "spotless" }
 
 [plugins]
 android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }
@@ -191,6 +194,7 @@ google-osslicenses = { id = "com.google.android.gms.oss-licenses-plugin", versio
 protobuf = { id = "com.google.protobuf", version.ref = "protobufPlugin" }
 roborazzi = { id = "io.github.takahirom.roborazzi", version.ref = "roborazzi" }
 room = { id = "androidx.room", version.ref = "room" }
+spotless = { id = "com.diffplug.spotless", version.ref = "spotless" }
 
 # Plugins defined by this project
 nowinandroid-android-application = { id = "nowinandroid.android.application" }
diff --git a/tools/pre-push b/tools/pre-push
index 81157f9ca..c931084cf 100644
--- a/tools/pre-push
+++ b/tools/pre-push
@@ -88,7 +88,7 @@ done
 if [[ -n "$run_checks" ]]; then
   # pre-push usually executes in the repository root, but just to be safe...
   cd "$(git rev-parse --show-toplevel)"
-  ./gradlew --init-script gradle/init.gradle.kts --no-configuration-cache check
+  ./gradlew --no-configuration-cache check
   exit $?
 fi