Set up static analysis checks

.editorconfig

@@ -0,0 +1,15 @@
+[*.{kt,kts}]
+
+max_line_length = 130
+indent_style = space
+indent_size = 4
+
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+ij_kotlin_allow_trailing_comma = true
+ij_kotlin_allow_trailing_comma_on_call_site = true
+
+continuation_indent_size = 4
+ktlint_standard_import-ordering = disabled
+ij_kotlin_imports_layout = *,java.**,javax.**,kotlin.**,^

.github/workflows/gradle-wrapper-validation.yml

@@ -9,7 +9,7 @@ on:
 
 jobs:
   validation:
-    name: Validation
+    name: Gradle Wrapper Validation
     runs-on: ubuntu-latest
     steps:
       - name: Checkout latest code

.github/workflows/pr-check.yml

@@ -0,0 +1,19 @@
+name: Check Pull Request
+on:
+  pull_request:
+    branches:
+      - '*'
+
+concurrency:
+  group: ${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout latest code
+        uses: actions/checkout@v4
+      - name: Run check
+        run: ./gradlew --project-dir plugin-build check

.github/workflows/publish.yml

@@ -16,6 +16,8 @@ jobs:
         uses: actions/checkout@v4
       - name: Setup Gradle
         uses: gradle/gradle-build-action@v2
+      - name: Run check
+        run: ./gradlew --project-dir plugin-build check
       - name: Publish on Plugin Portal
         run: ./gradlew --project-dir plugin-build setupPublishSecrets publishPlugins
         if: success()

config/detekt.yml

@@ -0,0 +1,42 @@
+build:
+  maxIssues: 5
+  excludeCorrectable: false
+
+config:
+  validation: true
+  warningsAsErrors: false
+  checkExhaustiveness: false
+  # when writing own rules with new properties, exclude the property path e.g.: 'my_rule_set,.*>.*>[my_property]'
+  excludes: ''
+
+naming:
+  active: true
+  MatchingDeclarationName:
+    active: false
+  FunctionNaming:
+    active: true
+    excludes: ['**/test/**']
+    functionPattern: '[a-z][a-zA-Z0-9]*'
+    excludeClassPattern: '$^'
+
+style:
+  active: true
+  UnusedPrivateMember:
+    active: true
+  MaxLineLength:
+    active: true
+    maxLineLength: 130 # Keep aligned with .editorconfig file to prevent false positives
+  MagicNumber:
+    active: true
+  DestructuringDeclarationWithTooManyEntries:
+    active: true
+
+complexity:
+  LongParameterList:
+    active: true
+  TooManyFunctions:
+    active: true
+    thresholdInInterfaces: 20
+    thresholdInClasses: 20
+  LongMethod:
+    active: true

gradle/libs.versions.toml

@@ -2,11 +2,15 @@
 kotlin = "1.9.20"
 publish = "1.2.1"
 kotlinx-serialization = "1.6.1"
+detekt = "1.23.3"
+ktlintGradle = "11.6.1"
 
 [libraries]
 kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlinx-serialization" }
 
 [plugins]
 kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
-gradle-pluginPublish = { id = "com.gradle.plugin-publish", version.ref = "publish" }
+gradle-pluginPublish = { id = "com.gradle.plugin-publish", version.ref = "publish" }
+detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt"}
+ktlint = { id = "org.jlleitschuh.gradle.ktlint", version.ref = "ktlintGradle"}

plugin-build/plugin/build.gradle.kts

@@ -1,7 +1,12 @@
+import io.gitlab.arturbosch.detekt.Detekt
+import org.jlleitschuh.gradle.ktlint.reporter.ReporterType
+
 plugins {
     alias(libs.plugins.kotlin.jvm)
     alias(libs.plugins.kotlin.serialization)
     alias(libs.plugins.gradle.pluginPublish)
+    alias(libs.plugins.detekt)
+    alias(libs.plugins.ktlint)
 }
 
 group = property("GROUP").toString()
@@ -44,4 +49,33 @@ tasks.create("setupPublishSecrets") {
         System.setProperty("gradle.publish.key", key)
         System.setProperty("gradle.publish.secret", secret)
     }
-}
+}
+
+detekt {
+    ignoreFailures = false
+    source.setFrom(files(projectDir))
+    config.setFrom(files("$rootDir/../config/detekt.yml"))
+    buildUponDefaultConfig = true
+}
+
+tasks.withType<Detekt> {
+    reports {
+        sarif.required.set(false)
+        md.required.set(false)
+        txt.required.set(true)
+        xml.required.set(true)
+    }
+}
+
+ktlint {
+    ignoreFailures.set(false)
+    android.set(true)
+    outputToConsole.set(true)
+    reporters {
+        reporter(ReporterType.PLAIN)
+        reporter(ReporterType.CHECKSTYLE)
+    }
+    filter {
+        exclude("**/generated/**")
+    }
+}

plugin-build/plugin/src/main/kotlin/app/futured/sheethappens/localizer/GoogleSheetParser.kt

@@ -17,7 +17,7 @@ internal object GoogleSheetParser {
         response: SpreadsheetResponse,
         sectionColumn: String?,
         keyColumn: String,
-        languageMapping: List<LanguageMapping>
+        languageMapping: List<LanguageMapping>,
     ): List<SheetEntry> {
         val rows = response.rows
         check(rows.isNotEmpty()) { error("Provided spreadsheet is empty") }
@@ -30,7 +30,7 @@ internal object GoogleSheetParser {
         }
         check(parsedColumns.any { it is TableColumn.Translation }) {
             "Google Sheet does not contain any columns specified in language mapping.\n" +
-                    "Columns specified: ${languageMapping.map { it.columnName }.joinToString()}"
+                "Columns specified: ${languageMapping.map { it.columnName }.joinToString()}"
         }
 
         return parseEntries(rows.drop(1), parsedColumns)
@@ -40,9 +40,8 @@ internal object GoogleSheetParser {
         row: TableRow,
         sectionColumn: String?,
         keyColumn: String,
-        languageMapping: List<LanguageMapping>
+        languageMapping: List<LanguageMapping>,
     ): List<TableColumn> = buildList {
-
         // Find section column
         row.indexOf(sectionColumn)
             .takeIf { index -> index >= 0 }
@@ -88,11 +87,11 @@ internal object GoogleSheetParser {
                                 column.locale to SheetEntry.PluralResource.Item(
                                     key = key.pluralKeyValue(),
                                     quantityModifier = key.pluralKeyModifier(),
-                                    value = columnValue
+                                    value = columnValue,
                                 )
                             }
                             .filterNotNull()
-                            .toMap()
+                            .toMap(),
                     )
                 } else {
                     return@mapNotNull SheetEntry.PlainResource(
@@ -101,13 +100,13 @@ internal object GoogleSheetParser {
                                 val columnValue = row[column] ?: return@map null
                                 column.locale to SheetEntry.PlainResource.Item(
                                     key = key,
-                                    value = columnValue
+                                    value = columnValue,
                                 )
                             }
                             .filterNotNull()
-                            .toMap()
+                            .toMap(),
                     )
                 }
             }
     }
-}
+}

plugin-build/plugin/src/main/kotlin/app/futured/sheethappens/localizer/ResourcesSerializer.kt

@@ -13,7 +13,7 @@ internal object ResourcesSerializer {
      */
     fun serialize(
         xmlElements: List<XmlElement>,
-        outputStream: OutputStream
+        outputStream: OutputStream,
     ) {
         XmlWriter(outputStream).document {
             xmlElements.forEach { xmlElement ->
@@ -84,4 +84,4 @@ private fun XmlWriter.writePluralResourceItem(quantityModifier: String, value: S
 private fun XmlWriter.flushAndClose() {
     flush()
     close()
-}
+}

plugin-build/plugin/src/main/kotlin/app/futured/sheethappens/localizer/SheetEntryAccumulator.kt

@@ -32,7 +32,7 @@ internal object SheetEntryAccumulator {
                     xmlEntries += XmlElement.PlainResource(
                         key = translation.key,
                         value = translation.value,
-                        comments = commentsAccumulator.toList()
+                        comments = commentsAccumulator.toList(),
                     )
                     commentsAccumulator.clear()
                 }
@@ -47,19 +47,19 @@ internal object SheetEntryAccumulator {
                             items = listOf(
                                 XmlElement.PluralResource.Item(
                                     translation.value,
-                                    translation.quantityModifier
-                                )
+                                    translation.quantityModifier,
+                                ),
                             ),
-                            comments = commentsAccumulator.toList()
+                            comments = commentsAccumulator.toList(),
                         )
                         commentsAccumulator.clear()
                     } else if (translation.key == pluralAccumulator.key) {
                         // Continue accumulating the same plural
                         pluralAccumulator = pluralAccumulator.copy(
                             items = pluralAccumulator.items + XmlElement.PluralResource.Item(
                                 value = translation.value,
-                                quantityModifier = translation.quantityModifier
-                            )
+                                quantityModifier = translation.quantityModifier,
+                            ),
                         )
                     }
                 }
@@ -84,4 +84,4 @@ internal object SheetEntryAccumulator {
 
         return xmlEntries.toList()
     }
-}
+}

plugin-build/plugin/src/main/kotlin/app/futured/sheethappens/localizer/XmlWriter.kt

@@ -57,4 +57,4 @@ internal class XmlWriter(outputStream: OutputStream) {
     fun close() {
         writer.close()
     }
-}
+}

plugin-build/plugin/src/main/kotlin/app/futured/sheethappens/localizer/api/GoogleSpreadsheetsApi.kt

@@ -26,4 +26,4 @@ internal class GoogleSpreadsheetsApi {
 
         return Json.decodeFromString(response)
     }
-}
+}

plugin-build/plugin/src/main/kotlin/app/futured/sheethappens/localizer/model/Locale.kt

@@ -4,4 +4,4 @@ package app.futured.sheethappens.localizer.model
  * The [Locale] maps specific column in Google Sheet identified by [columnName] to resource directory
  * in mobile application.
  */
-internal data class Locale(val columnName: String, val subdirectory: String)
+internal data class Locale(val columnName: String, val subdirectory: String)

plugin-build/plugin/src/main/kotlin/app/futured/sheethappens/localizer/model/SpreadsheetResponse.kt

@@ -16,5 +16,5 @@ internal data class SpreadsheetResponse(
     val majorDimension: String,
 
     @SerialName("values")
-    val rows: List<List<String>>
-)
+    val rows: List<List<String>>,
+)

plugin-build/plugin/src/main/kotlin/app/futured/sheethappens/localizer/model/Table.kt

@@ -14,4 +14,4 @@ internal operator fun TableRow.get(column: TableColumn?): String? = column?.let
 
 internal fun String.isPluralKey() = contains("##")
 internal fun String.pluralKeyModifier() = substringAfter("{").replace("}", "").trim()
-internal fun String.pluralKeyValue() = substringBefore("##")
+internal fun String.pluralKeyValue() = substringBefore("##")

plugin-build/plugin/src/main/kotlin/app/futured/sheethappens/localizer/model/XmlElement.kt

@@ -19,7 +19,7 @@ internal sealed interface XmlElement {
     data class PlainResource(
         val key: String,
         val value: String,
-        override val comments: List<String> = emptyList()
+        override val comments: List<String> = emptyList(),
     ) : XmlElement
 
     /**
@@ -35,8 +35,8 @@ internal sealed interface XmlElement {
     data class PluralResource(
         val key: String,
         val items: List<Item>,
-        override val comments: List<String> = emptyList()
+        override val comments: List<String> = emptyList(),
     ) : XmlElement {
         data class Item(val value: String, val quantityModifier: String)
     }
-}
+}