feat: apply convention plugins (#7)

Author: tim-romel-kr

.editorconfig

@@ -1,11 +1,14 @@
 root = true
 
 [*.{kt,kts}]
-disabled_rules = filename
-max_line_length = off
-insert_final_newline = true
-ij_kotlin_name_count_to_use_star_import = 999
-ij_kotlin_name_count_to_use_star_import_for_members = 999
 ij_java_class_count_to_use_import_on_demand = 999
 ij_kotlin_allow_trailing_comma = true
 ij_kotlin_allow_trailing_comma_on_call_site = true
+ij_kotlin_name_count_to_use_star_import = 999
+ij_kotlin_name_count_to_use_star_import_for_members = 999
+insert_final_newline = true
+max_line_length = off
+
+ktlint_code_style = intellij_idea
+ktlint_function_naming_ignore_when_annotated_with = Composable
+ktlint_standard_filename = disabled

.github/workflows/commit.yml

@@ -5,7 +5,11 @@ on: [ push, workflow_dispatch ]
 jobs:
   semantic_library_workflow:
     name: push
-    uses: krogerco/Shared-CI-Workflow-Android/.github/workflows/semantic_library_workflow.yml@v1.0.0
+    uses: krogerco/Shared-CI-Workflow-Android/.github/workflows/semantic_library_workflow.yml@v1.3.0
+    with:
+      java_version: '17'
+      ktlint_version: '-1'
+      test_command: 'test'
     secrets:
       ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.ORG_GRADLE_PROJECT_mavenCentralUsername }}
       ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.ORG_GRADLE_PROJECT_mavenCentralPassword }}

.husky/_/husky.sh

@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-npx --no-install commitlint --edit 
+npx --no-install commitlint --edit

.husky/commit-msg

@@ -1,4 +1,25 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
+### AUTOGENERATED KGP KOTLINTER HOOK START - DO NOT MODIFY ###
+staged_files="$(git --no-pager diff --name-status --no-color --staged | awk '$1 != "D" && $NF ~ /\.kts|\.kt/ { print $NF }')"
+if [ -z "$staged_files" ]; then
+    echo "No Kotlin files are staged."
+    exit 0
+fi;
 
-ktlint "**/src/**/*.kt" "!**/generated/**" --android --reporter=plain?group_by_file
+echo "Running ktlint on the following staged files:"
+echo "$staged_files"
+
+auto_format_files=false
+if [ "$auto_format_files" = true ] ; then
+    echo "auto-formatting staged files..."
+    ./gradlew formatKotlinFiles -Pfiles="$staged_files"
+fi
+
+if ! ./gradlew checkKotlinFiles -Pfiles="$staged_files"; then
+    echo "pre-commit hook: Some files are either not properly formatted or could not be auto-formatted. Aborting commit."
+    exit 1
+else
+    # Re-index any files that may have been corrected before committing
+    echo "$staged_files" | xargs git add
+    exit_code=0
+fi
+### AUTOGENERATED KGP KOTLINTER HOOK END ###

.husky/pre-commit

@@ -3,18 +3,15 @@
 All notable changes to this project will be documented in this file.
 `Cache-Android` adheres to [Semantic Versioning](https://semver.org/).
 
-## main
-
-### Added
-
-### Breaking Changes
-
-### Updated
-
-### Fixed
-
+## 3.1.0
+- [feat] use kotlin 1.9.23
+- [fix] remove kotlin serialization dependencies from android module
+- [build] use convention plugins
+- [chore] update sample app dependencies
+## 3.0.0
+- [feat!] renamed `CacheSerializer.decodeFromString(...)` to `CacheSerializer.decodeFromByteArray(...)`
+- [feat] add moshi serialization implementation module
+## 2.0.0
+- [feat!] abstract serialization and add kotlin serialization implementation module
 ## 1.0.0
-
-### Added
-
 - Initial open source release.

CHANGELOG.md

@@ -1,3 +1,5 @@
+import com.kroger.gradle.config.junitVintage
+
 /**
  * MIT License
  *
@@ -22,25 +24,27 @@
  * SOFTWARE.
  */
 plugins {
-    `android-library-module`
-    `release-module`
+    alias(libs.plugins.conventions.publishedAndroidLibrary)
 }
 
 android {
     namespace = "com.kroger.cache.android"
 }
 
+koverReport {
+    defaults {
+        mergeWith("debug")
+    }
+}
+
 dependencies {
     api(project(":cache"))
-    api(libs.kotlinx.serialization.core)
-    implementation(libs.kotlinx.serialization.json)
     implementation(libs.kotlinx.coroutines)
 
+    junitVintage()
     testImplementation(project(":kotlinx"))
-    testImplementation(libs.jupiter.api)
     testImplementation(libs.mockk)
     testImplementation(libs.truth)
-    testRuntimeOnly(libs.jupiter.engine)
 
     androidTestImplementation(libs.androidx.test.ext)
     androidTestImplementation(libs.androidx.test.rules)

android/build.gradle.kts

@@ -1,3 +1,5 @@
+import com.kroger.gradle.config.koverAllProjects
+
 /**
  * MIT License
  *
@@ -22,12 +24,31 @@
  * SOFTWARE.
  */
 plugins {
-    id("org.jetbrains.dokka")
-    id("com.google.devtools.ksp") version "1.7.20-1.0.8" apply false
+    alias(libs.plugins.android.application) apply false
+    alias(libs.plugins.android.junit5) apply false
+    alias(libs.plugins.conventions.androidApplication) apply false
+    alias(libs.plugins.conventions.publishedAndroidLibrary) apply false
+    alias(libs.plugins.conventions.publishedKotlinLibrary) apply false
+    alias(libs.plugins.conventions.root)
+    alias(libs.plugins.dependencyAnalysis) apply false
+    alias(libs.plugins.dokka)
+    alias(libs.plugins.gradleVersions) apply false
+    alias(libs.plugins.hilt) apply false
+    alias(libs.plugins.kapt) apply false
+    alias(libs.plugins.kotlinter) apply false
+    alias(libs.plugins.kover) apply true
+    alias(libs.plugins.ksp) apply false
+    alias(libs.plugins.mavenPublish) apply false
 }
 
-tasks {
-    register("clean", Delete::class) {
-        delete(rootProject.buildDir)
+koverReport {
+    filters {
+        excludes {
+            packages("com.kroger.cache.sampleapp")
+        }
     }
 }
+
+dependencies {
+    koverAllProjects(rootProject)
+}