improvement: spotless (#2383)

* spotless

* Adding spotless in the CI

* Added Java

---------

Co-authored-by: AR Abdul Azeez <abdul@onesignal.com>

Author: abdulraqeeb33

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
       - name: "[Test] Linting"
         working-directory: OneSignalSDK
         run: |
-          ./gradlew ktlintCheck --console=plain
+          ./gradlew spotlessCheck --console=plain
       - name: "[Test] SDK Unit Tests"
         working-directory: OneSignalSDK
         run: |

OneSignalSDK/.editorconfig

@@ -0,0 +1,37 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{kt,kts}]
+# Kotlin specific settings
+indent_size = 4
+indent_style = space
+max_line_length = 500
+ij_kotlin_allow_trailing_comma = false
+ij_kotlin_allow_trailing_comma_on_call_site = false
+
+# Disable ktlint wrapping rules to preserve existing code style
+ktlint_standard_wrapping = disabled
+ktlint_standard_parameter-list-wrapping = disabled
+ktlint_standard_argument-list-wrapping = disabled
+ktlint_standard_function-signature = disabled
+ktlint_standard_no-wildcard-imports = disabled
+ktlint_standard_trailing-comma-on-call-site = disabled
+ktlint_standard_trailing-comma-on-declaration-site = disabled
+
+[*.{gradle,gradle.kts}]
+indent_size = 4
+indent_style = space
+
+[*.xml]
+indent_size = 4
+indent_style = space
+
+[*.{md,txt}]
+trim_trailing_whitespace = true
+insert_final_newline = true
+

OneSignalSDK/build.gradle

@@ -15,10 +15,9 @@ buildscript {
         huaweiHMSLocationVersion = '4.0.0.300'
         kotlinVersion = '1.7.10'
         kotestVersion = '5.8.0'
-        ktlintPluginVersion = '11.6.1'
-        ktlintVersion = '1.0.1'
-        // DO NOT upgrade for tests, using an old version so it matches AOSP
-        tdunningJsonForTest = '1.0'
+        ktlintVersion = '1.0.1' // Used by Spotless for Kotlin formatting
+        spotlessVersion = '6.25.0'
+        tdunningJsonForTest = '1.0' // DO NOT upgrade for tests, using an old version so it matches AOSP
 
         sharedRepos = {
             google()
@@ -32,7 +31,7 @@ buildscript {
             "com.google.gms:google-services:$googleServicesGradlePluginVersion",
             "com.huawei.agconnect:agcp:$huaweiAgconnectVersion",
             "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlinVersion",
-            "org.jlleitschuh.gradle:ktlint-gradle:$ktlintPluginVersion",
+            "com.diffplug.spotless:spotless-plugin-gradle:$spotlessVersion",
             "com.vanniktech.maven.publish:com.vanniktech.maven.publish.gradle.plugin:0.32.0"
         ]
     }

OneSignalSDK/onesignal/core/build.gradle

@@ -1,7 +1,7 @@
 plugins {
     id 'com.android.library'
     id 'kotlin-android'
-    id 'org.jlleitschuh.gradle.ktlint'
+    id 'com.diffplug.spotless'
     id 'com.vanniktech.maven.publish'
 }
 
@@ -99,11 +99,5 @@ dependencies {
     testImplementation("com.tdunning:json:$tdunningJsonForTest")
 }
 
-ktlint {
-    version = "$ktlintVersion"
-    additionalEditorconfig = [
-        "max_line_length": "500",
-    ]
-}
-
+apply from: '../spotless.gradle'
 apply from: '../maven-push.gradle'

OneSignalSDK/onesignal/core/src/main/java/com/onesignal/session/internal/outcomes/impl/OutcomeEventsController.kt

@@ -147,7 +147,7 @@ internal class OutcomeEventsController(
             if (uniqueInfluences == null) {
                 Logging.debug(
                     """
-                    Measure endpoint will not send because unique outcome already sent for: 
+                    Measure endpoint will not send because unique outcome already sent for:
                     SessionInfluences: $influences
                     Outcome name: $name
                     """.trimIndent(),
@@ -162,7 +162,7 @@ internal class OutcomeEventsController(
             if (unattributedUniqueOutcomeEventsSentOnSession.contains(name)) {
                 Logging.debug(
                     """
-                    Measure endpoint will not send because unique outcome already sent for: 
+                    Measure endpoint will not send because unique outcome already sent for:
                     Session: ${InfluenceType.UNATTRIBUTED}
                     Outcome name: $name
                     """.trimIndent(),

OneSignalSDK/onesignal/core/src/main/res/anim/onesignal_fade_in.xml

@@ -3,4 +3,4 @@
     android:interpolator="@android:interpolator/accelerate_decelerate"
     android:fromAlpha="0.0"
     android:toAlpha="1.0"
-    android:duration="0" />
+    android:duration="0" />

OneSignalSDK/onesignal/core/src/main/res/anim/onesignal_fade_out.xml

@@ -3,4 +3,4 @@
     android:interpolator="@android:interpolator/accelerate_decelerate"
     android:fromAlpha="1.0"
     android:toAlpha="0.0"
-    android:duration="0" />
+    android:duration="0" />

OneSignalSDK/onesignal/core/src/main/res/raw/consumer_onesignal_keep.xml

@@ -9,4 +9,4 @@
            tools:discard="@raw/consumer_onesignal_keep" />
 
 <!-- Discard above doesn't seem to be working, file is added to .APK anyway but is only a packed size of 47 bytes.
-     XML comments are always omitted from the .APK. -->
+     XML comments are always omitted from the .APK. -->

OneSignalSDK/onesignal/in-app-messages/build.gradle

@@ -1,7 +1,7 @@
 plugins {
     id 'com.android.library'
     id 'kotlin-android'
-    id 'org.jlleitschuh.gradle.ktlint'
+    id 'com.diffplug.spotless'
     id 'com.vanniktech.maven.publish'
 }
 
@@ -100,11 +100,5 @@ dependencies {
     testImplementation("com.tdunning:json:$tdunningJsonForTest")
 }
 
-ktlint {
-    version = "$ktlintVersion"
-    additionalEditorconfig = [
-        "max_line_length": "500",
-    ]
-}
-
+apply from: '../spotless.gradle'
 apply from: '../maven-push.gradle'

OneSignalSDK/onesignal/in-app-messages/src/main/AndroidManifest.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest>
 
-</manifest>
+</manifest>