Install ktlint plugin

.editorconfig

@@ -9,25 +9,6 @@ insert_final_newline=true
 # it's automatically set to 100 on `ktlint --android ...` (per Android Kotlin Style Guide)
 max_line_length=off
 
-# Comma-separated list of rules to disable (Since 0.34.0)
-# Note that rules in any ruleset other than the standard ruleset will need to be prefixed
-# by the ruleset identifier.
-disabled_rules=no-multi-spaces,colon-spacing,chain-wrapping,import-ordering,experimental:annotation
-
-# The following (so far identified) rules are kept:
-# no-blank-line-before-rbrace
-# final-newline
-# no-consecutive-blank-lines
-# comment-spacing
-# filename
-# comma-spacing
-# paren-spacing
-# op-spacing
-# string-template
-# no-unused-imports
-# curly-spacing
-# no-semi
-# no-empty-class-body
-# experimental:multiline-if-else
-# experimental:no-empty-first-line-in-method-block
-# no-wildcard-imports
+# From https://github.com/pinterest/ktlint#custom-ktlint-specific-editorconfig-properties
+# default IntelliJ IDEA style, same as alphabetical, but with "java", "javax", "kotlin" and alias imports in the end of the imports list
+ij_kotlin_imports_layout=*,java.**,javax.**,kotlin.**,^

.github/workflows/quality.yml

@@ -21,8 +21,12 @@ jobs:
       - uses: actions/checkout@v2
       - name: Run klint
         run: |
-          curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.36.0/ktlint && chmod a+x ktlint
-          ./ktlint --android --experimental -v
+          ./gradlew ktlintCheck --continue
+      - name: Upload reports
+        uses: actions/upload-artifact@v2
+        with:
+          name: ktlinting-report
+          path: vector/build/reports/ktlint/*.*
 
 # Lint for main module and all the other modules
   android-lint:

.gitignore

@@ -16,4 +16,4 @@
 /fastlane/private
 /fastlane/report.xml
 
-ktlint
+/library/build

CONTRIBUTING.md

@@ -80,14 +80,13 @@ Make sure the following commands execute without any error:
 #### ktlint
 
 <pre>
-curl -sSLO https://github.com/pinterest/ktlint/releases/download/0.34.2/ktlint && chmod a+x ktlint
-./ktlint --android --experimental -v
+./gradlew ktlintCheck --continue
 </pre>
 
 Note that you can run
 
 <pre>
-./ktlint --android --experimental -v -F
+./gradlew ktlintFormat
 </pre>
 
 For ktlint to fix some detected errors for you (you still have to check and commit the fix of course)

attachment-viewer/src/main/java/im/vector/lib/attachmentviewer/AttachmentViewerActivity.kt

@@ -39,7 +39,6 @@ import androidx.core.view.updatePadding
 import androidx.transition.TransitionManager
 import androidx.viewpager2.widget.ViewPager2
 import im.vector.lib.attachmentviewer.databinding.ActivityAttachmentViewerBinding
-
 import java.lang.ref.WeakReference
 import kotlin.math.abs
 
@@ -291,8 +290,8 @@ abstract class AttachmentViewerActivity : AppCompatActivity(), AttachmentEventLi
     private fun calculateTranslationAlpha(translationY: Float, translationLimit: Int): Float =
             1.0f - 1.0f / translationLimit.toFloat() / 4f * abs(translationY)
 
-    private fun createSwipeToDismissHandler()
-            : SwipeToDismissHandler = SwipeToDismissHandler(
+    private fun createSwipeToDismissHandler(): SwipeToDismissHandler =
+            SwipeToDismissHandler(
             swipeView = views.dismissContainer,
             shouldAnimateDismiss = { shouldAnimateDismiss() },
             onDismiss = { animateClose() },

attachment-viewer/src/main/java/im/vector/lib/attachmentviewer/ImageLoaderTarget.kt

@@ -36,8 +36,8 @@ interface ImageLoaderTarget {
     fun onResourceReady(uid: String, resource: Drawable)
 }
 
-internal class DefaultImageLoaderTarget(val holder: AnimatedImageViewHolder, private val contextView: ImageView)
-    : ImageLoaderTarget {
+internal class DefaultImageLoaderTarget(val holder: AnimatedImageViewHolder, private val contextView: ImageView) :
+    ImageLoaderTarget {
     override fun contextView(): ImageView {
         return contextView
     }

build.gradle

@@ -27,7 +27,14 @@ buildscript {
     }
 }
 
+// ktlint Plugin
+plugins {
+    id "org.jlleitschuh.gradle.ktlint" version "10.1.0"
+}
+
 allprojects {
+    apply plugin: "org.jlleitschuh.gradle.ktlint"
+
     repositories {
         // For olm library. This has to be declared first, to ensure that Olm library is not downloaded from another repo
         maven {
@@ -75,6 +82,26 @@ allprojects {
         // You can override by passing `-PallWarningsAsErrors=false` in the command line
         kotlinOptions.allWarningsAsErrors = project.getProperties().getOrDefault("allWarningsAsErrors", "true").toBoolean()
     }
+
+    // Fix "Java heap space" issue
+    tasks.withType(org.jlleitschuh.gradle.ktlint.tasks.BaseKtLintCheckTask).configureEach {
+        it.workerMaxHeapSize.set("2G")
+    }
+
+    // See https://github.com/JLLeitschuh/ktlint-gradle#configuration
+    ktlint {
+        android = true
+        ignoreFailures = false
+        enableExperimentalRules = true
+        // display the corresponding rule
+        verbose = true
+        disabledRules = [
+                "spacing-between-declarations-with-comments",
+                "no-multi-spaces",
+                "experimental:spacing-between-declarations-with-annotations",
+                "experimental:annotation"
+        ]
+    }
 }
 
 task clean(type: Delete) {

changelog.d/3957.misc

@@ -0,0 +1 @@
+Use ktlint plugin. See [the documentation](https://github.com/vector-im/element-android/blob/develop/CONTRIBUTING.md#ktlint) for more detail.

matrix-sdk-android-rx/src/main/java/org/matrix/android/sdk/rx/LiveDataObservable.kt

@@ -34,8 +34,8 @@ private class LiveDataObservable<T>(
         liveData.observeForever(relay)
     }
 
-    private inner class RemoveObserverInMainThread(private val observer: io.reactivex.Observer<in T>)
-        : MainThreadDisposable(), Observer<T> {
+    private inner class RemoveObserverInMainThread(private val observer: io.reactivex.Observer<in T>) :
+        MainThreadDisposable(), Observer<T> {
 
         override fun onChanged(t: T?) {
             if (!isDisposed) {

matrix-sdk-android-rx/src/main/java/org/matrix/android/sdk/rx/OptionalRx.kt

@@ -16,8 +16,8 @@
 
 package org.matrix.android.sdk.rx
 
-import org.matrix.android.sdk.api.util.Optional
 import io.reactivex.Observable
+import org.matrix.android.sdk.api.util.Optional
 
 fun <T : Any> Observable<Optional<T>>.unwrap(): Observable<T> {
     return filter { it.hasValue() }.map { it.get() }

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/InstrumentedTest.kt

@@ -18,8 +18,8 @@ package org.matrix.android.sdk
 
 import android.content.Context
 import androidx.test.core.app.ApplicationProvider
-import org.matrix.android.sdk.test.shared.createTimberTestRule
 import org.junit.Rule
+import org.matrix.android.sdk.test.shared.createTimberTestRule
 
 interface InstrumentedTest {
 

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/SingleThreadCoroutineDispatcher.kt

@@ -16,9 +16,9 @@
 
 package org.matrix.android.sdk
 
-import org.matrix.android.sdk.internal.util.MatrixCoroutineDispatchers
 import kotlinx.coroutines.Dispatchers.Main
 import kotlinx.coroutines.asCoroutineDispatcher
+import org.matrix.android.sdk.internal.util.MatrixCoroutineDispatchers
 import java.util.concurrent.Executors
 
 internal val testCoroutineDispatchers = MatrixCoroutineDispatchers(Main, Main, Main, Main,

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/account/AccountCreationTest.kt

@@ -16,16 +16,16 @@
 
 package org.matrix.android.sdk.account
 
-import org.matrix.android.sdk.InstrumentedTest
-import org.matrix.android.sdk.common.CommonTestHelper
-import org.matrix.android.sdk.common.CryptoTestHelper
-import org.matrix.android.sdk.common.SessionTestParams
-import org.matrix.android.sdk.common.TestConstants
 import org.junit.FixMethodOrder
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.JUnit4
 import org.junit.runners.MethodSorters
+import org.matrix.android.sdk.InstrumentedTest
+import org.matrix.android.sdk.common.CommonTestHelper
+import org.matrix.android.sdk.common.CryptoTestHelper
+import org.matrix.android.sdk.common.SessionTestParams
+import org.matrix.android.sdk.common.TestConstants
 
 @RunWith(JUnit4::class)
 @FixMethodOrder(MethodSorters.JVM)

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/account/ChangePasswordTest.kt

@@ -16,17 +16,17 @@
 
 package org.matrix.android.sdk.account
 
-import org.matrix.android.sdk.InstrumentedTest
-import org.matrix.android.sdk.api.failure.isInvalidPassword
-import org.matrix.android.sdk.common.CommonTestHelper
-import org.matrix.android.sdk.common.SessionTestParams
-import org.matrix.android.sdk.common.TestConstants
 import org.amshove.kluent.shouldBeTrue
 import org.junit.FixMethodOrder
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.JUnit4
 import org.junit.runners.MethodSorters
+import org.matrix.android.sdk.InstrumentedTest
+import org.matrix.android.sdk.api.failure.isInvalidPassword
+import org.matrix.android.sdk.common.CommonTestHelper
+import org.matrix.android.sdk.common.SessionTestParams
+import org.matrix.android.sdk.common.TestConstants
 
 @RunWith(JUnit4::class)
 @FixMethodOrder(MethodSorters.JVM)

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/account/DeactivateAccountTest.kt

@@ -67,9 +67,9 @@ class DeactivateAccountTest : InstrumentedTest {
         val throwable = commonTestHelper.logAccountWithError(session.myUserId, TestConstants.PASSWORD)
 
         // Test the error
-        assertTrue(throwable is Failure.ServerError
-                && throwable.error.code == MatrixError.M_USER_DEACTIVATED
-                && throwable.error.message == "This account has been deactivated")
+        assertTrue(throwable is Failure.ServerError &&
+                throwable.error.code == MatrixError.M_USER_DEACTIVATED &&
+                throwable.error.message == "This account has been deactivated")
 
         // Try to create an account with the deactivate account user id, it will fail (M_USER_IN_USE)
         val hs = commonTestHelper.createHomeServerConfig()
@@ -95,8 +95,8 @@ class DeactivateAccountTest : InstrumentedTest {
 
         // Test the error
         accountCreationError.let {
-            assertTrue(it is Failure.ServerError
-                    && it.error.code == MatrixError.M_USER_IN_USE)
+            assertTrue(it is Failure.ServerError &&
+                    it.error.code == MatrixError.M_USER_IN_USE)
         }
 
         // No need to close the session, it has been deactivated

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/common/MockOkHttpInterceptor.kt

@@ -15,12 +15,12 @@
  */
 package org.matrix.android.sdk.common
 
-import org.matrix.android.sdk.internal.session.TestInterceptor
 import okhttp3.Interceptor
 import okhttp3.Protocol
 import okhttp3.Request
 import okhttp3.Response
 import okhttp3.ResponseBody.Companion.toResponseBody
+import org.matrix.android.sdk.internal.session.TestInterceptor
 import javax.net.ssl.HttpsURLConnection
 
 /**

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/common/TestMatrixCallback.kt

@@ -17,8 +17,8 @@
 package org.matrix.android.sdk.common
 
 import androidx.annotation.CallSuper
-import org.matrix.android.sdk.api.MatrixCallback
 import org.junit.Assert.fail
+import org.matrix.android.sdk.api.MatrixCallback
 import timber.log.Timber
 import java.util.concurrent.CountDownLatch
 

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/crypto/AttachmentEncryptionTest.kt

@@ -26,9 +26,9 @@ import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.MethodSorters
 import org.matrix.android.sdk.internal.crypto.attachments.MXEncryptedAttachments
+import org.matrix.android.sdk.internal.crypto.attachments.toElementToDecrypt
 import org.matrix.android.sdk.internal.crypto.model.rest.EncryptedFileInfo
 import org.matrix.android.sdk.internal.crypto.model.rest.EncryptedFileKey
-import org.matrix.android.sdk.internal.crypto.attachments.toElementToDecrypt
 import java.io.ByteArrayOutputStream
 import java.io.InputStream
 

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/crypto/CryptoStoreHelper.kt

@@ -16,12 +16,12 @@
 
 package org.matrix.android.sdk.internal.crypto
 
+import io.realm.RealmConfiguration
 import org.matrix.android.sdk.internal.crypto.store.IMXCryptoStore
 import org.matrix.android.sdk.internal.crypto.store.db.RealmCryptoStore
 import org.matrix.android.sdk.internal.crypto.store.db.RealmCryptoStoreModule
 import org.matrix.android.sdk.internal.crypto.store.db.mapper.CrossSigningKeysMapper
 import org.matrix.android.sdk.internal.di.MoshiProvider
-import io.realm.RealmConfiguration
 import kotlin.random.Random
 
 internal class CryptoStoreHelper {

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/crypto/CryptoStoreTest.kt

@@ -17,16 +17,16 @@
 package org.matrix.android.sdk.internal.crypto
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
-import org.matrix.android.sdk.InstrumentedTest
-import org.matrix.android.sdk.internal.crypto.model.OlmSessionWrapper
-import org.matrix.android.sdk.internal.crypto.store.IMXCryptoStore
 import io.realm.Realm
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertNotEquals
 import org.junit.Assert.assertNull
 import org.junit.Before
 import org.junit.Test
 import org.junit.runner.RunWith
+import org.matrix.android.sdk.InstrumentedTest
+import org.matrix.android.sdk.internal.crypto.model.OlmSessionWrapper
+import org.matrix.android.sdk.internal.crypto.store.IMXCryptoStore
 import org.matrix.olm.OlmAccount
 import org.matrix.olm.OlmManager
 import org.matrix.olm.OlmSession

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/crypto/PreShareKeysTest.kt

@@ -50,8 +50,8 @@ class PreShareKeysTest : InstrumentedTest {
         aliceSession.cryptoService().discardOutboundSession(e2eRoomID)
 
         val preShareCount = bobSession.cryptoService().getGossipingEvents().count {
-            it.senderId == aliceSession.myUserId
-                    && it.getClearType() == EventType.ROOM_KEY
+            it.senderId == aliceSession.myUserId &&
+                    it.getClearType() == EventType.ROOM_KEY
         }
 
         assertEquals("Bob should not have receive any key from alice at this point", 0, preShareCount)
@@ -65,16 +65,16 @@ class PreShareKeysTest : InstrumentedTest {
         mTestHelper.waitWithLatch { latch ->
             mTestHelper.retryPeriodicallyWithLatch(latch) {
                 val newGossipCount = bobSession.cryptoService().getGossipingEvents().count {
-                    it.senderId == aliceSession.myUserId
-                            && it.getClearType() == EventType.ROOM_KEY
+                    it.senderId == aliceSession.myUserId &&
+                            it.getClearType() == EventType.ROOM_KEY
                 }
                 newGossipCount > preShareCount
             }
         }
 
         val latest = bobSession.cryptoService().getGossipingEvents().lastOrNull {
-            it.senderId == aliceSession.myUserId
-                    && it.getClearType() == EventType.ROOM_KEY
+            it.senderId == aliceSession.myUserId &&
+                    it.getClearType() == EventType.ROOM_KEY
         }
 
         val content = latest?.getClearContent().toModel<RoomKeyContent>()

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/crypto/gossiping/WithHeldTests.kt

@@ -18,6 +18,11 @@ package org.matrix.android.sdk.internal.crypto.gossiping
 
 import android.util.Log
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import org.junit.Assert
+import org.junit.FixMethodOrder
+import org.junit.Test
+import org.junit.runner.RunWith
+import org.junit.runners.MethodSorters
 import org.matrix.android.sdk.InstrumentedTest
 import org.matrix.android.sdk.api.NoOpMatrixCallback
 import org.matrix.android.sdk.api.extensions.tryOrNull
@@ -31,11 +36,6 @@ import org.matrix.android.sdk.common.SessionTestParams
 import org.matrix.android.sdk.common.TestConstants
 import org.matrix.android.sdk.internal.crypto.model.event.EncryptedEventContent
 import org.matrix.android.sdk.internal.crypto.model.event.WithHeldCode
-import org.junit.Assert
-import org.junit.FixMethodOrder
-import org.junit.Test
-import org.junit.runner.RunWith
-import org.junit.runners.MethodSorters
 
 @RunWith(AndroidJUnit4::class)
 @FixMethodOrder(MethodSorters.JVM)

matrix-sdk-android/src/androidTest/java/org/matrix/android/sdk/internal/crypto/keysbackup/KeysBackupPasswordTest.kt

@@ -17,9 +17,6 @@
 package org.matrix.android.sdk.internal.crypto.keysbackup
 
 import androidx.test.ext.junit.runners.AndroidJUnit4
-import org.matrix.android.sdk.InstrumentedTest
-import org.matrix.android.sdk.api.listeners.ProgressListener
-import org.matrix.android.sdk.common.assertByteArrayNotEqual
 import org.junit.Assert.assertArrayEquals
 import org.junit.Assert.assertEquals
 import org.junit.Assert.assertTrue
@@ -28,6 +25,9 @@ import org.junit.FixMethodOrder
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.junit.runners.MethodSorters
+import org.matrix.android.sdk.InstrumentedTest
+import org.matrix.android.sdk.api.listeners.ProgressListener
+import org.matrix.android.sdk.common.assertByteArrayNotEqual
 import org.matrix.olm.OlmManager
 import org.matrix.olm.OlmPkDecryption