Lint Kotlin examples (com-lihaoyi#3923)

* [x] Needs com-lihaoyi#3919 as this builds on it
* [x] Update this to use com-lihaoyi#3961, switching to `KtlintModule`
* [x] Needs com-lihaoyi#3966 to disable ktlint for some files

Last change I think needed for com-lihaoyi#3829

Overview:
* Changes `KtfmtModule` to set the error code when there's changes like
is true of the other formatters.
* Some simplifications were made to the `example/package.mill` based on
similarities with Java/Kotlin.
* Files were formatted
* CI was updated

---------

Co-authored-by: Li Haoyi <[email protected]>

Author: myyk

.editorconfig

@@ -13,3 +13,16 @@ insert_final_newline = true
 charset = utf-8
 indent_style = space
 indent_size = 2
+
+[*.{kt,kts}]
+ktlint_code_style = intellij_idea
+ktlint_standard_no-wildcard-imports = disabled
+
+[example/kotlinlib/linting/**/*]
+ktlint = disabled
+
+[kotlinlib/test/resources/contrib/ktfmt/**/*]
+ktlint = disabled
+
+[kotlinlib/test/resources/kotlin-js/foo/test/src/foo/**/*]
+ktlint = disabled

.github/workflows/run-tests.yml

@@ -183,4 +183,4 @@ jobs:
     uses: ./.github/workflows/run-mill-action.yml
     with:
       java-version: '17'
-      buildcmd: ./mill -i mill.scalalib.scalafmt.ScalafmtModule/checkFormatAll __.sources && ./mill -i __.mimaReportBinaryIssues && ./mill -i __.fix --check && ./mill -i mill.javalib.palantirformat.PalantirFormatModule/ --check
+      buildcmd: ./mill -i mill.scalalib.scalafmt.ScalafmtModule/checkFormatAll __.sources + __.mimaReportBinaryIssues + __.fix --check + mill.javalib.palantirformat.PalantirFormatModule/ --check + mill.kotlinlib.ktlint.KtlintModule/checkFormatAll --check

example/kotlinlib/basic/1-simple/foo/src/foo/Foo.kt

@@ -1,21 +1,19 @@
 package foo
 
-import kotlinx.html.h1
-import kotlinx.html.stream.createHTML
 import com.github.ajalt.clikt.core.CliktCommand
 import com.github.ajalt.clikt.parameters.options.option
 import com.github.ajalt.clikt.parameters.options.required
+import kotlinx.html.h1
+import kotlinx.html.stream.createHTML
 
-class Foo: CliktCommand() {
-    val text by option("-t", "--text", help="text to insert").required()
+class Foo : CliktCommand() {
+    val text by option("-t", "--text", help = "text to insert").required()
 
     override fun run() {
         echo(generateHtml(text))
     }
 }
 
-fun generateHtml(text: String): String {
-    return createHTML(prettyPrint = false).h1 { text(text)  }.toString()
-}
+fun generateHtml(text: String): String = createHTML(prettyPrint = false).h1 { text(text) }.toString()
 
 fun main(args: Array<String>) = Foo().main(args)

example/kotlinlib/basic/1-simple/foo/test/src/foo/FooTest.kt

@@ -1,15 +1,15 @@
 package foo
 
-import foo.generateHtml
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
 
-class FooTest : FunSpec({
-    test("testSimple") {
-        generateHtml("hello") shouldBe "<h1>hello</h1>"
-    }
+class FooTest :
+    FunSpec({
+        test("testSimple") {
+            generateHtml("hello") shouldBe "<h1>hello</h1>"
+        }
 
-    test("testEscaping") {
-        generateHtml("<hello>") shouldBe "<h1>&lt;hello&gt;</h1>"
-    }
-})
+        test("testEscaping") {
+            generateHtml("<hello>") shouldBe "<h1>&lt;hello&gt;</h1>"
+        }
+    })

example/kotlinlib/basic/2-custom-build-logic/foo/src/foo/Foo.kt

@@ -2,16 +2,16 @@ package foo
 
 import java.io.IOException
 
-fun getLineCount(): String? {
-    return try {
-        ::main.javaClass.classLoader
-            .getResourceAsStream("line-count.txt")
-            .readAllBytes()
-            .toString(Charsets.UTF_8)
-    } catch (e: IOException) {
-        null
-    }
+fun getLineCount(): String? = try {
+    ::main.javaClass.classLoader
+        .getResourceAsStream("line-count.txt")
+        .readAllBytes()
+        .toString(Charsets.UTF_8)
+} catch (e: IOException) {
+    null
 }
 
-fun main() = println("Line Count: " + getLineCount())
-
+fun main() {
+    var msg = "Line Count: " + getLineCount()
+    println(msg)
+}

example/kotlinlib/basic/2-custom-build-logic/foo/test/src/foo/FooTests.kt

@@ -1,14 +1,14 @@
 package foo
 
-import foo.getLineCount
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
 
-class FooTests : FunSpec({
+class FooTests :
+    FunSpec({
 
-    test("testSimple") {
-        val expectedLineCount = 12
-        val actualLineCount = getLineCount()?.trim().let { Integer.parseInt(it) }
-        actualLineCount shouldBe expectedLineCount
-    }
-})
+        test("testSimple") {
+            val expectedLineCount = 12
+            val actualLineCount = getLineCount()?.trim().let { Integer.parseInt(it) }
+            actualLineCount shouldBe expectedLineCount
+        }
+    })

example/kotlinlib/basic/3-multi-module/bar/src/bar/Bar.kt

@@ -3,9 +3,7 @@ package bar
 import kotlinx.html.h1
 import kotlinx.html.stream.createHTML
 
-fun generateHtml(text: String): String {
-    return createHTML(prettyPrint = false).h1 { text(text)  }.toString()
-}
+fun generateHtml(text: String): String = createHTML(prettyPrint = false).h1 { text(text) }.toString()
 
 fun main(args: Array<String>) {
     println("Bar.value: " + generateHtml(args[0]))

example/kotlinlib/basic/3-multi-module/bar/test/src/bar/BarTests.kt

@@ -1,18 +1,18 @@
 package bar
 
-import bar.generateHtml
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
 
-class BarTests : FunSpec({
+class BarTests :
+    FunSpec({
 
-    test("simple") {
-        val result = generateHtml("hello")
-        result shouldBe "<h1>hello</h1>"
-    }
+        test("simple") {
+            val result = generateHtml("hello")
+            result shouldBe "<h1>hello</h1>"
+        }
 
-    test("escaping") {
-        val result = generateHtml("<hello>")
-        result shouldBe "<h1>&lt;hello&gt;</h1>"
-    }
-})
+        test("escaping") {
+            val result = generateHtml("<hello>")
+            result shouldBe "<h1>&lt;hello&gt;</h1>"
+        }
+    })

example/kotlinlib/basic/3-multi-module/foo/src/foo/Foo.kt

@@ -6,7 +6,7 @@ import com.github.ajalt.clikt.parameters.options.required
 
 const val VALUE: String = "hello"
 
-class Foo: CliktCommand() {
+class Foo : CliktCommand() {
     val fooText by option("--foo-text").required()
     val barText by option("--bar-text").required()
 
@@ -15,7 +15,10 @@ class Foo: CliktCommand() {
     }
 }
 
-fun mainFunction(fooText: String, barText: String) {
+fun mainFunction(
+    fooText: String,
+    barText: String,
+) {
     println("Foo.value: " + VALUE)
     println("Bar.value: " + bar.generateHtml(barText))
 }

example/kotlinlib/basic/4-compat-modules/foo/src/test/java/foo/FooTests.kt

@@ -3,9 +3,10 @@ package foo
 import io.kotest.core.spec.style.FunSpec
 import io.kotest.matchers.shouldBe
 
-class FooTests : FunSpec({
-    test("hello") {
-        val result = hello()
-        result shouldBe "Hello World, Earth"
-    }
-})
+class FooTests :
+    FunSpec({
+        test("hello") {
+            val result = hello()
+            result shouldBe "Hello World, Earth"
+        }
+    })