Replace Spotless with Kotlinter and applying KtLint (#2419)

Task/Issue URL:
https://app.asana.com/0/1174433894299346/1203115816821758

### Description
This PR replaces Spotless with Kotlinter to format code using Ktlint.
Updated .editorconfig

Author: malmstein

.editorconfig

@@ -18,8 +18,8 @@ ij_kotlin_align_multiline_extends_list = false
 ij_kotlin_align_multiline_method_parentheses = false
 ij_kotlin_align_multiline_parameters = false
 ij_kotlin_align_multiline_parameters_in_calls = false
-ij_kotlin_allow_trailing_comma = false
-ij_kotlin_allow_trailing_comma_on_call_site = false
+ij_kotlin_allow_trailing_comma = true
+ij_kotlin_allow_trailing_comma_on_call_site = true
 ij_kotlin_assignment_wrap = normal
 ij_kotlin_blank_lines_after_class_header = 0
 ij_kotlin_blank_lines_around_block_when_branches = 0

.githooks/pre-commit

@@ -2,5 +2,6 @@
     #!/bin/bash
     echo "Running spotless check"
     ./gradlew spotlessApply
+    ./gradlew formatKotlin
     git add `git diff --name-only --cached`
     exit 0

.github/workflows/ci.yml

@@ -18,8 +18,8 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  spotless:
-    name: Spotless
+  code_formatting:
+    name: Code Formatting
     runs-on: ubuntu-latest
 
     steps:
@@ -34,10 +34,10 @@ jobs:
           java-version: '11'
           distribution: 'adopt'
 
-      - name: Spotless
+      - name: Run Code Formatting Checks
         uses: gradle/gradle-build-action@v2
         with:
-          arguments: spotless
+          arguments: code_format_checks
 
   unit_tests:
     name: Unit tests

ad-click/ad-click-api/build.gradle

@@ -19,7 +19,7 @@ plugins {
     id 'kotlin'
 }
 
-apply from: "$rootProject.projectDir/spotless.gradle"
+apply from: "$rootProject.projectDir/code-formatting.gradle"
 
 java {
     sourceCompatibility = JavaVersion.VERSION_1_8

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/AdClickAttributionFeature.kt

@@ -20,7 +20,7 @@ data class AdClickAttributionFeature(
     val state: String,
     val minSupportedVersion: Int?,
     val settings: AdClickAttributionSettings,
-    val exceptions: List<AdClickAttributionException>
+    val exceptions: List<AdClickAttributionException>,
 )
 
 data class AdClickAttributionSettings(
@@ -29,17 +29,17 @@ data class AdClickAttributionSettings(
     val navigationExpiration: Long,
     val totalExpiration: Long,
     val heuristicDetection: String?,
-    val domainDetection: String?
+    val domainDetection: String?,
 )
 
 data class AdClickAttributionLinkFormat(
     val url: String,
-    val adDomainParameterName: String?
+    val adDomainParameterName: String?,
 )
 
 data class AdClickAttributionAllowlist(
     val blocklistEntry: String?,
-    val host: String?
+    val host: String?,
 )
 
 data class AdClickAttributionException(val domain: String, val reason: String)

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/AdClickAttributionPlugin.kt

@@ -34,7 +34,7 @@ import javax.inject.Inject
 @ContributesMultibinding(AppScope::class)
 class AdClickAttributionPlugin @Inject constructor(
     private val adClickAttributionRepository: AdClickAttributionRepository,
-    private val adClickFeatureTogglesRepository: AdClickFeatureToggleRepository
+    private val adClickFeatureTogglesRepository: AdClickFeatureToggleRepository,
 ) : PrivacyFeaturePlugin {
 
     override fun store(featureName: String, jsonString: String): Boolean {
@@ -55,8 +55,8 @@ class AdClickAttributionPlugin @Inject constructor(
                 linkFormats.add(
                     AdClickAttributionLinkFormatEntity(
                         url = it.url,
-                        adDomainParameterName = it.adDomainParameterName.orEmpty()
-                    )
+                        adDomainParameterName = it.adDomainParameterName.orEmpty(),
+                    ),
                 )
             }
 
@@ -70,14 +70,14 @@ class AdClickAttributionPlugin @Inject constructor(
                 expirations.add(
                     AdClickAttributionExpirationEntity(
                         navigationExpiration = it.navigationExpiration,
-                        totalExpiration = it.totalExpiration
-                    )
+                        totalExpiration = it.totalExpiration,
+                    ),
                 )
                 detections.add(
                     AdClickAttributionDetectionEntity(
                         heuristicDetection = it.heuristicDetection.orEmpty(),
-                        domainDetection = it.domainDetection.orEmpty()
-                    )
+                        domainDetection = it.domainDetection.orEmpty(),
+                    ),
                 )
             }
 

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/AdClickFeatureTogglesPlugin.kt

@@ -26,7 +26,7 @@ import javax.inject.Inject
 @ContributesMultibinding(AppScope::class)
 class AdClickFeatureTogglesPlugin @Inject constructor(
     private val adClickFeatureToggleRepository: AdClickFeatureToggleRepository,
-    private val appBuildConfig: AppBuildConfig
+    private val appBuildConfig: AppBuildConfig,
 ) : FeatureTogglesPlugin {
     override fun isEnabled(featureName: String, defaultValue: Boolean): Boolean? {
         val adClickFeature = adClickFeatureValueOf(featureName) ?: return null

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/DataRemovalAdClickWorker.kt

@@ -31,10 +31,10 @@ import com.duckduckgo.anvil.annotations.ContributesWorker
 import com.duckduckgo.app.global.DispatcherProvider
 import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesMultibinding
-import kotlinx.coroutines.withContext
-import timber.log.Timber
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
+import kotlinx.coroutines.withContext
+import timber.log.Timber
 
 @ContributesWorker(AppScope::class)
 class DataRemovalAdClickWorker(context: Context, workerParameters: WorkerParameters) :
@@ -57,10 +57,10 @@ class DataRemovalAdClickWorker(context: Context, workerParameters: WorkerParamet
 
 @ContributesMultibinding(
     scope = AppScope::class,
-    boundType = LifecycleObserver::class
+    boundType = LifecycleObserver::class,
 )
 class DataRemovalAdClickWorkerScheduler @Inject constructor(
-    private val workManager: WorkManager
+    private val workManager: WorkManager,
 ) : DefaultLifecycleObserver {
 
     override fun onCreate(owner: LifecycleOwner) {

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/DuckDuckGoAdClickData.kt

@@ -18,8 +18,8 @@ package com.duckduckgo.adclick.impl
 
 import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
-import timber.log.Timber
 import javax.inject.Inject
+import timber.log.Timber
 
 interface AdClickData {
 

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/DuckDuckGoAdClickManager.kt

@@ -23,16 +23,16 @@ import com.duckduckgo.app.global.UriString
 import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
 import dagger.SingleInstanceIn
+import javax.inject.Inject
 import okhttp3.internal.publicsuffix.PublicSuffixDatabase
 import timber.log.Timber
-import javax.inject.Inject
 
 @SingleInstanceIn(AppScope::class)
 @ContributesBinding(AppScope::class)
 class DuckDuckGoAdClickManager @Inject constructor(
     private val adClickData: AdClickData,
     private val adClickAttribution: AdClickAttribution,
-    private val adClickPixels: AdClickPixels
+    private val adClickPixels: AdClickPixels,
 ) : AdClickManager {
 
     private val publicSuffixDatabase = PublicSuffixDatabase()
@@ -147,8 +147,8 @@ class DuckDuckGoAdClickManager @Inject constructor(
                 // navigation to another domain, add expiry
                 adClickData.addExemption(
                     exemption.copy(
-                        navigationExemptionDeadline = System.currentTimeMillis() + adClickAttribution.getNavigationExpirationMillis()
-                    )
+                        navigationExemptionDeadline = System.currentTimeMillis() + adClickAttribution.getNavigationExpirationMillis(),
+                    ),
                 )
             } else {
                 // navigation back to an existing domain, remove expiry
@@ -188,8 +188,8 @@ class DuckDuckGoAdClickManager @Inject constructor(
                     tabId,
                     sourceTabExemption.copy(
                         navigationExemptionDeadline = Exemption.NO_EXPIRY,
-                        adClickActivePixelFired = false
-                    )
+                        adClickActivePixelFired = false,
+                    ),
                 )
                 adClickPixels.updateCountPixel(AdClickPixelName.AD_CLICK_PAGELOADS_WITH_AD_ATTRIBUTION)
             }
@@ -201,8 +201,8 @@ class DuckDuckGoAdClickManager @Inject constructor(
                 sourceTabExemption.copy(
                     hostTldPlusOne = sourceTabHostTldPLusOne,
                     navigationExemptionDeadline = System.currentTimeMillis() + adClickAttribution.getNavigationExpirationMillis(),
-                    adClickActivePixelFired = false
-                )
+                    adClickActivePixelFired = false,
+                ),
             )
             adClickPixels.updateCountPixel(AdClickPixelName.AD_CLICK_PAGELOADS_WITH_AD_ATTRIBUTION)
         }
@@ -214,14 +214,14 @@ class DuckDuckGoAdClickManager @Inject constructor(
                 Exemption(
                     hostTldPlusOne = savedAdDomain.ifEmpty { urlAdDomain },
                     navigationExemptionDeadline = Exemption.NO_EXPIRY,
-                    exemptionDeadline = System.currentTimeMillis() + adClickAttribution.getTotalExpirationMillis()
-                )
+                    exemptionDeadline = System.currentTimeMillis() + adClickAttribution.getTotalExpirationMillis(),
+                ),
             )
             adClickPixels.fireAdClickDetectedPixel(
                 savedAdDomain = savedAdDomain,
                 urlAdDomain = urlAdDomain,
                 heuristicEnabled = adClickAttribution.isHeuristicDetectionEnabled(),
-                domainEnabled = adClickAttribution.isDomainDetectionEnabled()
+                domainEnabled = adClickAttribution.isDomainDetectionEnabled(),
             )
             adClickPixels.updateCountPixel(AdClickPixelName.AD_CLICK_PAGELOADS_WITH_AD_ATTRIBUTION)
         }

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/Exemption.kt

@@ -20,7 +20,7 @@ data class Exemption(
     val hostTldPlusOne: String,
     val navigationExemptionDeadline: Long,
     val exemptionDeadline: Long,
-    val adClickActivePixelFired: Boolean = false
+    val adClickActivePixelFired: Boolean = false,
 ) {
     fun isExpired(): Boolean {
         val now = System.currentTimeMillis()

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/RealAdClickAttribution.kt

@@ -40,7 +40,7 @@ interface AdClickAttribution {
 @ContributesBinding(AppScope::class)
 class RealAdClickAttribution @Inject constructor(
     private val adClickAttributionRepository: AdClickAttributionRepository,
-    private val featureToggle: FeatureToggle
+    private val featureToggle: FeatureToggle,
 ) : AdClickAttribution {
 
     override fun isAllowed(url: String): Boolean {

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/di/AdClickModule.kt

@@ -50,7 +50,7 @@ class AdClickModule {
     fun provideAdClickAttributionRepository(
         database: AdClickDatabase,
         @AppCoroutineScope coroutineScope: CoroutineScope,
-        dispatcherProvider: DispatcherProvider
+        dispatcherProvider: DispatcherProvider,
     ): AdClickAttributionRepository {
         return RealAdClickAttributionRepository(database, coroutineScope, dispatcherProvider)
     }

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/pixels/AdClickDailyReportingWorker.kt

@@ -30,10 +30,10 @@ import com.duckduckgo.anvil.annotations.ContributesWorker
 import com.duckduckgo.app.global.DispatcherProvider
 import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesMultibinding
-import kotlinx.coroutines.withContext
-import timber.log.Timber
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
+import kotlinx.coroutines.withContext
+import timber.log.Timber
 
 @ContributesWorker(AppScope::class)
 class AdClickDailyReportingWorker(context: Context, workerParameters: WorkerParameters) :
@@ -55,10 +55,10 @@ class AdClickDailyReportingWorker(context: Context, workerParameters: WorkerPara
 
 @ContributesMultibinding(
     scope = AppScope::class,
-    boundType = LifecycleObserver::class
+    boundType = LifecycleObserver::class,
 )
 class AdClickDailyReportingWorkerScheduler @Inject constructor(
-    private val workManager: WorkManager
+    private val workManager: WorkManager,
 ) : DefaultLifecycleObserver {
 
     override fun onCreate(owner: LifecycleOwner) {

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/pixels/AdClickPixelName.kt

@@ -21,7 +21,7 @@ import com.duckduckgo.app.statistics.pixels.Pixel
 enum class AdClickPixelName(override val pixelName: String) : Pixel.PixelName {
     AD_CLICK_DETECTED("m_ad_click_detected"),
     AD_CLICK_ACTIVE("m_ad_click_active"),
-    AD_CLICK_PAGELOADS_WITH_AD_ATTRIBUTION("m_pageloads_with_ad_attribution")
+    AD_CLICK_PAGELOADS_WITH_AD_ATTRIBUTION("m_pageloads_with_ad_attribution"),
 }
 
 object AdClickPixelValues {

ad-click/ad-click-impl/src/main/java/com/duckduckgo/adclick/impl/pixels/AdClickPixels.kt

@@ -24,9 +24,9 @@ import com.duckduckgo.adclick.impl.pixels.AdClickPixelParameters.AD_CLICK_PAGELO
 import com.duckduckgo.app.statistics.pixels.Pixel
 import com.duckduckgo.di.scopes.AppScope
 import com.squareup.anvil.annotations.ContributesBinding
-import org.threeten.bp.Instant
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
+import org.threeten.bp.Instant
 
 interface AdClickPixels {
     fun fireAdClickActivePixel(exemption: Exemption?): Boolean
@@ -38,7 +38,7 @@ interface AdClickPixels {
 @ContributesBinding(AppScope::class)
 class RealAdClickPixels @Inject constructor(
     private val pixel: Pixel,
-    private val context: Context
+    private val context: Context,
 ) : AdClickPixels {
 
     private val preferences: SharedPreferences

ad-click/ad-click-impl/src/test/java/com/duckduckgo/adclick/impl/AdClickAttributionPluginTest.kt

@@ -45,7 +45,7 @@ class AdClickAttributionPluginTest {
     fun before() {
         testee = AdClickAttributionPlugin(
             mockAdClickAttributionRepository,
-            mockFeatureTogglesRepository
+            mockFeatureTogglesRepository,
         )
     }
 
@@ -94,7 +94,7 @@ class AdClickAttributionPluginTest {
             linkFormats = linkFormatCaptor.capture(),
             allowList = allowlistCaptor.capture(),
             expirations = expirationCaptor.capture(),
-            detections = detectionsCaptor.capture()
+            detections = detectionsCaptor.capture(),
         )
 
         val linkFormatEntity = linkFormatCaptor.firstValue