add spotless with ktlint (#13170)

* spotless with ktlint

* disable spotless on generated newtoki and wolfdotcom files

* fetch depth

(cherry picked from commit bec7c8d)

Author: AwkwardPeak7

.github/workflows/build_pull_request.yml

@@ -62,6 +62,7 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           persist-credentials: false
+          fetch-depth: 0
 
       - name: Set up Java
         uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0

.github/workflows/build_push.yml

@@ -82,6 +82,7 @@ jobs:
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           persist-credentials: false
+          fetch-depth: 0
 
       - name: Set up Java
         uses: actions/setup-java@be666c2fcd27ec809703dec50e508c2fdc7f6654 # v5.2.0

buildSrc/build.gradle.kts

@@ -12,4 +12,5 @@ dependencies {
     implementation(libs.gradle.agp)
     implementation(libs.gradle.kotlin)
     implementation(libs.gradle.serialization)
+    implementation(libs.spotless.gradle)
 }

buildSrc/src/main/kotlin/keiyoushi.lint.gradle.kts

@@ -0,0 +1,49 @@
+plugins {
+    id("com.diffplug.spotless")
+}
+
+spotless {
+    ratchetFrom = "68ed874a42038f4efd001c555cba9bf7de8474d7"
+
+    kotlin {
+        target("**/*.kt", "**/*.kts")
+        targetExclude("**/build/**/*.kt")
+        ktlint()
+            .editorConfigOverride(mapOf(
+                "ktlint_standard_discouraged-comment-location" to "disabled",
+                "ktlint_function_signature_body_expression_wrapping" to "default",
+                "ktlint_standard_chain-method-continuation" to "disable"
+            ))
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+
+    java {
+        target("**/*.java")
+        targetExclude("**/build/**/*.java")
+        googleJavaFormat()
+        removeUnusedImports()
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+
+    format("gradle") {
+        target("**/*.gradle")
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+
+    format("xml") {
+        target("**/*.xml")
+        targetExclude("**/build/**/*.xml")
+        trimTrailingWhitespace()
+        endWithNewline()
+    }
+}
+
+tasks {
+    val spotlessTask = if (System.getenv("CI") != "true") "spotlessApply" else "spotlessCheck"
+    named("preBuild") {
+        dependsOn(tasks.getByName(spotlessTask))
+    }
+}

buildSrc/src/main/kotlin/lib-multisrc.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     id("com.android.library")
     id("kotlinx-serialization")
+    id("keiyoushi.lint")
 }
 
 android {

common.gradle

@@ -2,6 +2,7 @@ import com.android.build.gradle.tasks.PackageAndroidArtifact
 
 apply plugin: 'com.android.application'
 apply plugin: 'kotlinx-serialization'
+apply plugin: 'keiyoushi.lint'
 
 assert !ext.has("pkgNameSuffix")
 assert !ext.has("libVersion")

core/build.gradle.kts

@@ -1,5 +1,6 @@
 plugins {
     id("com.android.library")
+    id("keiyoushi.lint")
 }
 
 android {

gradle/libs.versions.toml

@@ -13,6 +13,8 @@ gradle-agp = { module = "com.android.tools.build:gradle", version = "9.0.0" }
 gradle-kotlin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 gradle-serialization = { module = "org.jetbrains.kotlin:kotlin-serialization", version.ref = "kotlin" }
 
+spotless-gradle = { group = "com.diffplug.spotless", name = "spotless-plugin-gradle", version = "8.2.1" }
+
 tachiyomi-lib = { module = "com.github.komikku-app:extensions-lib", version = "1.7.1" }
 
 kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }

src/ko/newtoki/build.gradle

@@ -11,13 +11,14 @@ def domainNumberFileName = "src/ko/newtoki/src/eu/kanade/tachiyomi/extension/ko/
 def domainNumberFile = new File(domainNumberFileName)
 def backupFile = new File(domainNumberFileName + "_bak")
 
-task updateDomainNumber {
+tasks.register('updateDomainNumber') {
     doLast {
         def domainNumberUrl = "https://stevenyomi.github.io/source-domains/newtoki.txt"
         def number = new URL(domainNumberUrl).withInputStream { it.readLines()[0] }
         println("[NewToki] Updating domain number to $number")
         domainNumberFile.renameTo(backupFile)
         domainNumberFile.withPrintWriter {
+            it.println("// spotless:off")
             it.println("// THIS FILE IS AUTO-GENERATED, DO NOT COMMIT")
             it.println("package eu.kanade.tachiyomi.extension.ko.newtoki")
             it.println("const val fallbackDomainNumber = \"$number\"")
@@ -27,7 +28,7 @@ task updateDomainNumber {
 
 preBuild.dependsOn updateDomainNumber
 
-task restoreBackup {
+tasks.register('restoreBackup') {
     doLast {
         if (backupFile.exists()) {
             println("[NewToki] Restoring placeholder file")
@@ -37,7 +38,7 @@ task restoreBackup {
     }
 }
 
-tasks.whenTaskAdded { task ->
+tasks.configureEach { task ->
     if (task.name == "assembleDebug" || task.name == "assembleRelease") {
         task.finalizedBy(restoreBackup)
     }

src/ko/wolfdotcom/build.gradle

@@ -26,6 +26,7 @@ tasks.register('updateDomainNumber') {
         if (domainNumber != -1) {
             domainNumberFile.renameTo(backupFile)
             domainNumberFile.withPrintWriter {
+                it.println("// spotless:off")
                 it.println("// THIS FILE IS AUTO-GENERATED, DO NOT COMMIT")
                 it.println("package eu.kanade.tachiyomi.extension.ko.wolfdotcom")
                 it.println("const val DEFAULT_DOMAIN_NUMBER = \"$domainNumber\"")