Adds ktlint to project

.github/workflows/android_build.yml

@@ -17,5 +17,8 @@ jobs:
       - name: Build Project
         run: ./gradlew assemble
 
+      - name: Lint Checks
+        run: ./gradlew ktlint
+
       - name: Run Tests
         run: ./gradlew test

app/build.gradle

@@ -3,6 +3,8 @@ plugins {
     id 'org.jetbrains.kotlin.android'
 }
 
+apply from: new File(rootProject.projectDir, "./buildscripts/ktlint.gradle")
+
 android {
     compileSdk 31
 

app/src/androidTest/java/com/example/envelopebudget/ExampleInstrumentedTest.kt

@@ -1,13 +1,11 @@
 package com.example.envelopebudget
 
-import androidx.test.platform.app.InstrumentationRegistry
 import androidx.test.ext.junit.runners.AndroidJUnit4
-
+import androidx.test.platform.app.InstrumentationRegistry
+import junit.framework.Assert.assertEquals
 import org.junit.Test
 import org.junit.runner.RunWith
 
-import org.junit.Assert.*
-
 /**
  * Instrumented test, which will execute on an Android device.
  *
@@ -21,4 +19,4 @@ class ExampleInstrumentedTest {
         val appContext = InstrumentationRegistry.getInstrumentation().targetContext
         assertEquals("com.example.envelopebudget", appContext.packageName)
     }
-}
+}

app/src/main/java/com/example/envelopebudget/MainActivity.kt

@@ -40,4 +40,4 @@ fun DefaultPreview() {
     EnvelopeBudgetTheme {
         Greeting("Android")
     }
-}
+}

app/src/main/java/com/example/envelopebudget/ui/theme/Color.kt

@@ -5,4 +5,4 @@ import androidx.compose.ui.graphics.Color
 val Purple200 = Color(0xFFBB86FC)
 val Purple500 = Color(0xFF6200EE)
 val Purple700 = Color(0xFF3700B3)
-val Teal200 = Color(0xFF03DAC5)
+val Teal200 = Color(0xFF03DAC5)

app/src/main/java/com/example/envelopebudget/ui/theme/Shape.kt

@@ -8,4 +8,4 @@ val Shapes = Shapes(
     small = RoundedCornerShape(4.dp),
     medium = RoundedCornerShape(4.dp),
     large = RoundedCornerShape(0.dp)
-)
+)

app/src/main/java/com/example/envelopebudget/ui/theme/Theme.kt

@@ -44,4 +44,4 @@ fun EnvelopeBudgetTheme(
         shapes = Shapes,
         content = content
     )
-}
+}

app/src/main/java/com/example/envelopebudget/ui/theme/Type.kt

@@ -25,4 +25,4 @@ val Typography = Typography(
         fontSize = 12.sp
     )
     */
-)
+)

app/src/test/java/com/example/envelopebudget/ExampleUnitTest.kt

@@ -1,9 +1,8 @@
 package com.example.envelopebudget
 
+import junit.framework.Assert.assertEquals
 import org.junit.Test
 
-import org.junit.Assert.*
-
 /**
  * Example local unit test, which will execute on the development machine (host).
  *
@@ -14,4 +13,4 @@ class ExampleUnitTest {
     fun addition_isCorrect() {
         assertEquals(4, 2 + 2)
     }
-}
+}

build.gradle

@@ -2,7 +2,9 @@ buildscript {
     ext {
         compose_version = '1.0.1'
     }
-}// Top-level build file where you can add configuration options common to all sub-projects/modules.
+}
+
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
 plugins {
     id 'com.android.application' version '7.1.3' apply false
     id 'com.android.library' version '7.1.3' apply false

buildscripts/ktlint.gradle

@@ -0,0 +1,28 @@
+configurations {
+    ktlint
+}
+
+dependencies {
+    ktlint "com.pinterest:ktlint:0.43.1"
+    // additional 3rd party ruleset(s) can be specified here
+    // just add them to the classpath (ktlint 'groupId:artifactId:version') and
+    // ktlint will pick them up
+}
+
+task ktlint(type: JavaExec, group: "verification") {
+    description = "Check Kotlin code style."
+    main = "com.pinterest.ktlint.Main"
+    classpath = configurations.ktlint
+    args "src/**/*.kt"
+    // to generate report in checkstyle format prepend following args:
+    // "--reporter=plain", "--reporter=checkstyle,output=${buildDir}/ktlint.xml"
+    // see https://github.com/pinterest/ktlint#usage for more
+}
+check.dependsOn ktlint
+
+task ktlintFormat(type: JavaExec, group: "formatting") {
+    description = "Fix Kotlin code style deviations."
+    main = "com.pinterest.ktlint.Main"
+    classpath = configurations.ktlint
+    args "-F", "src/**/*.kt"
+}