Switch to a new Ktlint Formatter (#705)

* Switch to new Ktlint plugin * Add ktlintCheck to PR builds * Run formatter * Put ktlint version in libs toml * Fix lint * Use Zip4Java from libs.toml
Suwayomi · Oct 7, 2023 · 849acfc · 849acfc
1 parent 3cd3cb0
commit 849acfc
Show file tree

Hide file tree

Showing 277 changed files with 6,660 additions and 5,041 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,11 @@
+[*.{kt,kts}]
+indent_size=4
+insert_final_newline=true
+ij_kotlin_allow_trailing_comma=true
+ij_kotlin_allow_trailing_comma_on_call_site=true
+ij_kotlin_name_count_to_use_star_import=2147483647
+ij_kotlin_name_count_to_use_star_import_for_members=2147483647
+
+ktlint_standard_discouraged-comment-location=disabled
+ktlint_standard_if-else-wrapping=disabled
+ktlint_standard_no-consecutive-comments=disabled
diff --git a/.github/workflows/build_pull_request.yml b/.github/workflows/build_pull_request.yml
@@ -49,5 +49,5 @@ jobs:
         uses: gradle/gradle-build-action@v2
         with:
           build-root-directory: master
-          arguments: :server:shadowJar --stacktrace
+          arguments: ktlintCheck :server:shadowJar --stacktrace
 
diff --git a/AndroidCompat/Config/build.gradle.kts b/AndroidCompat/Config/build.gradle.kts
@@ -1,12 +1,11 @@
-@Suppress("DSL_SCOPE_VIOLATION")
 plugins {
     id(libs.plugins.kotlin.jvm.get().pluginId)
     id(libs.plugins.kotlin.serialization.get().pluginId)
-    id(libs.plugins.kotlinter.get().pluginId)
+    id(libs.plugins.ktlint.get().pluginId)
 }
 
 dependencies {
     // Shared
     implementation(libs.bundles.shared)
     testImplementation(libs.bundles.sharedTest)
-}
+}
diff --git a/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/ApplicationRootDir.kt b/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/ApplicationRootDir.kt
@@ -15,6 +15,6 @@ val ApplicationRootDir: String
     get(): String {
         return System.getProperty(
             "$CONFIG_PREFIX.server.rootDir",
-            AppDirsFactory.getInstance().getUserDataDir("Tachidesk", null, null)
+            AppDirsFactory.getInstance().getUserDataDir("Tachidesk", null, null),
         )
     }
diff --git a/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/ConfigKodeinModule.kt b/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/ConfigKodeinModule.kt
@@ -5,8 +5,9 @@ import org.kodein.di.bind
 import org.kodein.di.singleton
 
 class ConfigKodeinModule {
-    fun create() = DI.Module("ConfigManager") {
-        // Config module
-        bind<ConfigManager>() with singleton { GlobalConfigManager }
-    }
+    fun create() =
+        DI.Module("ConfigManager") {
+            // Config module
+            bind<ConfigManager>() with singleton { GlobalConfigManager }
+        }
 }
diff --git a/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/ConfigManager.kt b/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/ConfigManager.kt
@@ -63,19 +63,21 @@ open class ConfigManager {
         val baseConfig =
             ConfigFactory.parseMap(
                 mapOf(
-                    "androidcompat.rootDir" to "$ApplicationRootDir/android-compat" // override AndroidCompat's rootDir
-                )
+                    // override AndroidCompat's rootDir
+                    "androidcompat.rootDir" to "$ApplicationRootDir/android-compat",
+                ),
             )
 
         // Load user config
         val userConfig = getUserConfig()
 
-        val config = ConfigFactory.empty()
-            .withFallback(baseConfig)
-            .withFallback(userConfig)
-            .withFallback(compatConfig)
-            .withFallback(serverConfig)
-            .resolve()
+        val config =
+            ConfigFactory.empty()
+                .withFallback(baseConfig)
+                .withFallback(userConfig)
+                .withFallback(compatConfig)
+                .withFallback(serverConfig)
+                .resolve()
 
         // set log level early
         if (debugLogsEnabled(config)) {
@@ -95,14 +97,20 @@ open class ConfigManager {
         }
     }
 
-    private fun updateUserConfigFile(path: String, value: ConfigValue) {
+    private fun updateUserConfigFile(
+        path: String,
+        value: ConfigValue,
+    ) {
         val userConfigDoc = ConfigDocumentFactory.parseFile(userConfigFile)
         val updatedConfigDoc = userConfigDoc.withValue(path, value)
         val newFileContent = updatedConfigDoc.render()
         userConfigFile.writeText(newFileContent)
     }
 
-    suspend fun updateValue(path: String, value: Any) {
+    suspend fun updateValue(
+        path: String,
+        value: Any,
+    ) {
         mutex.withLock {
             val configValue = ConfigValueFactory.fromAnyRef(value)
 
@@ -140,10 +148,16 @@ open class ConfigManager {
             return
         }
 
-        logger.debug { "user config is out of date, updating... (missingSettings= $hasMissingSettings, outdatedSettings= $hasOutdatedSettings" }
+        logger.debug {
+            "user config is out of date, updating... (missingSettings= $hasMissingSettings, outdatedSettings= $hasOutdatedSettings"
+        }
 
         var newUserConfigDoc: ConfigDocument = resetUserConfig(false)
-        userConfig.entrySet().filter { serverConfig.hasPath(it.key) }.forEach { newUserConfigDoc = newUserConfigDoc.withValue(it.key, it.value) }
+        userConfig.entrySet().filter {
+            serverConfig.hasPath(
+                it.key,
+            )
+        }.forEach { newUserConfigDoc = newUserConfigDoc.withValue(it.key, it.value) }
 
         userConfigFile.writeText(newUserConfigDoc.render())
     }

diff --git a/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/ConfigModule.kt b/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/ConfigModule.kt
@@ -26,13 +26,17 @@ abstract class SystemPropertyOverridableConfigModule(getConfig: () -> Config, mo
 
 /** Defines a config property that is overridable with jvm `-D` commandline arguments prefixed with [CONFIG_PREFIX] */
 class SystemPropertyOverrideDelegate(val getConfig: () -> Config, val moduleName: String) {
-    inline operator fun <R, reified T> getValue(thisRef: R, property: KProperty<*>): T {
+    inline operator fun <R, reified T> getValue(
+        thisRef: R,
+        property: KProperty<*>,
+    ): T {
         val configValue: T = getConfig().getValue(thisRef, property)
 
-        val combined = System.getProperty(
-            "$CONFIG_PREFIX.$moduleName.${property.name}",
-            configValue.toString()
-        )
+        val combined =
+            System.getProperty(
+                "$CONFIG_PREFIX.$moduleName.${property.name}",
+                configValue.toString(),
+            )
 
         return when (T::class.simpleName) {
             "Int" -> combined.toInt()

diff --git a/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/Logging.kt b/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/Logging.kt
@@ -19,31 +19,37 @@ import mu.KotlinLogging
 import org.slf4j.Logger
 import org.slf4j.LoggerFactory
 
-private fun createRollingFileAppender(logContext: LoggerContext, logDirPath: String): RollingFileAppender<ILoggingEvent> {
+private fun createRollingFileAppender(
+    logContext: LoggerContext,
+    logDirPath: String,
+): RollingFileAppender<ILoggingEvent> {
     val logFilename = "application"
 
-    val logEncoder = PatternLayoutEncoder().apply {
-        pattern = "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n"
-        context = logContext
-        start()
-    }
-
-    val appender = RollingFileAppender<ILoggingEvent>().apply {
-        name = "FILE"
-        context = logContext
-        encoder = logEncoder
-        file = "$logDirPath/$logFilename.log"
-    }
-
-    val rollingPolicy = SizeAndTimeBasedRollingPolicy<ILoggingEvent>().apply {
-        context = logContext
-        setParent(appender)
-        fileNamePattern = "$logDirPath/${logFilename}_%d{yyyy-MM-dd}_%i.log.gz"
-        setMaxFileSize(FileSize.valueOf("10mb"))
-        maxHistory = 14
-        setTotalSizeCap(FileSize.valueOf("1gb"))
-        start()
-    }
+    val logEncoder =
+        PatternLayoutEncoder().apply {
+            pattern = "%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n"
+            context = logContext
+            start()
+        }
+
+    val appender =
+        RollingFileAppender<ILoggingEvent>().apply {
+            name = "FILE"
+            context = logContext
+            encoder = logEncoder
+            file = "$logDirPath/$logFilename.log"
+        }
+
+    val rollingPolicy =
+        SizeAndTimeBasedRollingPolicy<ILoggingEvent>().apply {
+            context = logContext
+            setParent(appender)
+            fileNamePattern = "$logDirPath/${logFilename}_%d{yyyy-MM-dd}_%i.log.gz"
+            setMaxFileSize(FileSize.valueOf("10mb"))
+            maxHistory = 14
+            setTotalSizeCap(FileSize.valueOf("1gb"))
+            start()
+        }
 
     appender.rollingPolicy = rollingPolicy
     appender.start()
@@ -72,12 +78,16 @@ fun initLoggerConfig(appRootPath: String) {
 
 const val BASE_LOGGER_NAME = "_BaseLogger"
 
-fun setLogLevelFor(name: String, level: Level) {
-    val logger = if (name == BASE_LOGGER_NAME) {
-        getBaseLogger()
-    } else {
-        getLogger(name)
-    }
+fun setLogLevelFor(
+    name: String,
+    level: Level,
+) {
+    val logger =
+        if (name == BASE_LOGGER_NAME) {
+            getBaseLogger()
+        } else {
+            getLogger(name)
+        }
 
     logger.level = level
 }

diff --git a/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/util/ConfigExtensions.kt b/AndroidCompat/Config/src/main/java/xyz/nulldev/ts/config/util/ConfigExtensions.kt
@@ -2,5 +2,6 @@ package xyz.nulldev.ts.config.util
 
 import com.typesafe.config.Config
 
-operator fun Config.get(key: String) = getString(key)
-    ?: throw IllegalStateException("Could not find value for config entry: $key!")
+operator fun Config.get(key: String) =
+    getString(key)
+        ?: throw IllegalStateException("Could not find value for config entry: $key!")
diff --git a/AndroidCompat/build.gradle.kts b/AndroidCompat/build.gradle.kts
@@ -1,8 +1,7 @@
-@Suppress("DSL_SCOPE_VIOLATION")
 plugins {
     id(libs.plugins.kotlin.jvm.get().pluginId)
     id(libs.plugins.kotlin.serialization.get().pluginId)
-    id(libs.plugins.kotlinter.get().pluginId)
+    id(libs.plugins.ktlint.get().pluginId)
 }
 
 dependencies {

diff --git a/AndroidCompat/src/main/java/android/preference/PreferenceManager.kt b/AndroidCompat/src/main/java/android/preference/PreferenceManager.kt
@@ -12,7 +12,7 @@ class PreferenceManager {
         fun getDefaultSharedPreferences(context: Context) =
             context.getSharedPreferences(
                 context.applicationInfo.packageName,
-                Context.MODE_PRIVATE
+                Context.MODE_PRIVATE,
             )!!
     }
 }
diff --git a/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/AndroidCompat.kt b/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/AndroidCompat.kt
@@ -7,7 +7,6 @@ import org.kodein.di.instance
 import xyz.nulldev.androidcompat.androidimpl.CustomContext
 
 class AndroidCompat {
-
     val context: CustomContext by DI.global.instance()
 
     fun startApp(application: Application) {

diff --git a/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/AndroidCompatInitializer.kt b/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/AndroidCompatInitializer.kt
@@ -18,10 +18,13 @@ class AndroidCompatInitializer {
         GlobalConfigManager.registerModules(
             FilesConfigModule.register(GlobalConfigManager.config),
             ApplicationInfoConfigModule.register(GlobalConfigManager.config),
-            SystemConfigModule.register(GlobalConfigManager.config)
+            SystemConfigModule.register(GlobalConfigManager.config),
         )
 
         // Set some properties extensions use
-        System.setProperty("http.agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36")
+        System.setProperty(
+            "http.agent",
+            "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
+        )
     }
 }
diff --git a/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/AndroidCompatModule.kt b/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/AndroidCompatModule.kt
@@ -18,22 +18,24 @@ import xyz.nulldev.androidcompat.service.ServiceSupport
  */
 
 class AndroidCompatModule {
-    fun create() = DI.Module("AndroidCompat") {
-        bind<AndroidFiles>() with singleton { AndroidFiles() }
+    fun create() =
+        DI.Module("AndroidCompat") {
+            bind<AndroidFiles>() with singleton { AndroidFiles() }
 
-        bind<ApplicationInfoImpl>() with singleton { ApplicationInfoImpl() }
+            bind<ApplicationInfoImpl>() with singleton { ApplicationInfoImpl() }
 
-        bind<ServiceSupport>() with singleton { ServiceSupport() }
+            bind<ServiceSupport>() with singleton { ServiceSupport() }
 
-        bind<FakePackageManager>() with singleton { FakePackageManager() }
+            bind<FakePackageManager>() with singleton { FakePackageManager() }
 
-        bind<PackageController>() with singleton { PackageController() }
+            bind<PackageController>() with singleton { PackageController() }
 
-        // Context
-        bind<CustomContext>() with singleton { CustomContext() }
-        bind<Context>() with singleton {
-            val context: Context by DI.global.instance<CustomContext>()
-            context
+            // Context
+            bind<CustomContext>() with singleton { CustomContext() }
+            bind<Context>() with
+                singleton {
+                    val context: Context by DI.global.instance<CustomContext>()
+                    context
+                }
         }
-    }
 }
diff --git a/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/config/ApplicationInfoConfigModule.kt b/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/config/ApplicationInfoConfigModule.kt
@@ -13,7 +13,6 @@ class ApplicationInfoConfigModule(getConfig: () -> Config) : ConfigModule(getCon
     val debug: Boolean by getConfig()
 
     companion object {
-        fun register(config: Config) =
-            ApplicationInfoConfigModule { config.getConfig("android.app") }
+        fun register(config: Config) = ApplicationInfoConfigModule { config.getConfig("android.app") }
     }
 }
diff --git a/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/config/FilesConfigModule.kt b/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/config/FilesConfigModule.kt
@@ -28,7 +28,6 @@ class FilesConfigModule(getConfig: () -> Config) : ConfigModule(getConfig) {
     val packageDir: String by getConfig()
 
     companion object {
-        fun register(config: Config) =
-            FilesConfigModule { config.getConfig("android.files") }
+        fun register(config: Config) = FilesConfigModule { config.getConfig("android.files") }
     }
 }
diff --git a/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/config/SystemConfigModule.kt b/AndroidCompat/src/main/java/xyz/nulldev/androidcompat/config/SystemConfigModule.kt
@@ -10,13 +10,16 @@ class SystemConfigModule(val getConfig: () -> Config) : ConfigModule(getConfig)
     val propertyPrefix = "properties."
 
     fun getStringProperty(property: String) = getConfig().getString("$propertyPrefix$property")!!
+
     fun getIntProperty(property: String) = getConfig().getInt("$propertyPrefix$property")
+
     fun getLongProperty(property: String) = getConfig().getLong("$propertyPrefix$property")
+
     fun getBooleanProperty(property: String) = getConfig().getBoolean("$propertyPrefix$property")
+
     fun hasProperty(property: String) = getConfig().hasPath("$propertyPrefix$property")
 
     companion object {
-        fun register(config: Config) =
-            SystemConfigModule { config.getConfig("android.system") }
+        fun register(config: Config) = SystemConfigModule { config.getConfig("android.system") }
     }
 }