Merge pull request #817 from simple-robot/apply-detekt

配置与应用detekt

Author: ForteScarlet

.editorconfig

@@ -6,7 +6,7 @@ indent_style = space
 insert_final_newline = true
 max_line_length = 120
 tab_width = 4
-ij_continuation_indent_size = 8
+ij_continuation_indent_size = 4
 ij_formatter_off_tag = @formatter:off
 ij_formatter_on_tag = @formatter:on
 ij_formatter_tags_enabled = true

.github/workflows/publish-v4-release.yml

@@ -45,7 +45,7 @@ jobs:
         uses: actions/upload-artifact@v4
         if: ${{ always() }}
         with:
-          name: test-reports-${{ matrix.os }}
+          name: test-reports-${{ runner.os }}
           path: '**/build/reports/tests'
           retention-days: 7
 

.github/workflows/test-branch.yml

@@ -16,7 +16,6 @@ jobs:
         os: [ macos-latest, windows-latest, ubuntu-latest ]
     runs-on: ${{ matrix.os }}
     steps:
-    
       - uses: actions/checkout@v4
       - uses: actions/setup-java@v4
         with:
@@ -27,11 +26,46 @@ jobs:
       - name: Run All Tests
         uses: gradle/gradle-build-action@v3
         with:
-          gradle-version: 8.3
+          gradle-version: 8.5
           arguments: |
             assemble
             build
             allTests
             --info 
             --warning-mode all
 
+      - name: Upload test reports
+        uses: actions/upload-artifact@v4
+        if: ${{ always() }}
+        with:
+          name: test-reports-${{ runner.os }}
+          path: '**/build/reports'
+          retention-days: 7
+
+  detekt-check:
+    name: Detekt check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: 11
+          cache: 'gradle'
+      - name: Run Detekt
+        uses: gradle/gradle-build-action@v3
+        with:
+          gradle-version: 8.5
+          arguments: |
+            assemble
+            detekt
+            --info 
+            --warning-mode all
+
+      - name: Upload detekt reports
+        uses: actions/upload-artifact@v4
+        if: ${{ always() }}
+        with:
+          name: detekt-reports-${{ runner.os }}
+          path: 'build/reports/detekt'
+          retention-days: 7

.github/workflows/test-v4-branch.yml

@@ -8,6 +8,10 @@ env:
   IS_CI: true
   GRADLE_OPTS: "-Dfile.encoding=UTF-8"
 
+concurrency:
+  group: '${{ github.workflow }}-${{ github.ref }}'
+  cancel-in-progress: true
+
 jobs:
   build-v4-test:
     name: Build and test
@@ -41,3 +45,39 @@ jobs:
           name: test-reports-${{ matrix.os }}
           path: '**/build/reports/tests'
           retention-days: 7
+
+  detekt-check:
+    name: Detekt check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          distribution: 'zulu'
+          java-version: 11
+          cache: 'gradle'
+      - name: Run Detekt
+        uses: gradle/gradle-build-action@v3
+        with:
+          gradle-version: 8.5
+          arguments: |
+            detekt
+            --info 
+            --warning-mode all
+
+      - name: Upload detekt reports
+        uses: actions/upload-artifact@v4
+        if: ${{ always() }}
+        with:
+          name: detekt-reports
+          path: 'build/reports/detekt'
+          retention-days: 7
+
+      # https://detekt.dev/docs/introduction/reporting/#integration-with-github-code-scanning
+      # Make sure we always run this upload task,
+      # because the previous step may fail if there are findings.
+      - name: Upload SARIF to GitHub using the upload-sarif action
+        uses: github/codeql-action/upload-sarif@v2
+        if: ${{ always() }}
+        with:
+          sarif_file: 'build/reports/detekt/detekt.sarif'

.idea/codeStyles/Project.xml

@@ -21,19 +21,21 @@
  *
  */
 
+import io.gitlab.arturbosch.detekt.Detekt
 import love.forte.gradle.common.core.project.setup
 
 plugins {
     idea
     id("simbot.dokka-multi-module")
     id("com.github.gmazzo.buildconfig") version "4.1.2" apply false
-    id("io.gitlab.arturbosch.detekt")
+    alias(libs.plugins.detekt)
     id("simbot.nexus-publish")
     id("simbot.changelog-generator")
 
     // https://www.jetbrains.com/help/qodana/code-coverage.html
     // https://github.com/Kotlin/kotlinx-kover
     id("org.jetbrains.kotlinx.kover") version "0.7.6"
+
 }
 
 setup(P.Simbot)
@@ -74,12 +76,12 @@ subprojects {
 
         fun Project.hasKtP(): Boolean {
             return plugins.findPlugin("org.jetbrains.kotlin.jvm") != null ||
-                    plugins.findPlugin("org.jetbrains.kotlin.multiplatform") != null
+                plugins.findPlugin("org.jetbrains.kotlin.multiplatform") != null
         }
 
         if (hasKtP()) {
 //            apply(plugin = "io.gitlab.arturbosch.detekt")
-            applyDetekt()
+            // applyDetekt()
             if ("gradle" !in name) {
                 useK2()
                 logger.info("Enable K2 for {}", this)
@@ -91,23 +93,51 @@ subprojects {
 
 }
 
-fun Project.applyDetekt() {
-//     apply(plugin = "io.gitlab.arturbosch.detekt")
-//
-//     detekt {
-// //        buildUponDefaultConfig = true
-//         config.from(rootProject.projectDir.resolve(".detekt/config/detekt.yml"))
-//         baseline = rootProject.projectDir.resolve(".detekt/baseline/detekt-baseline.xml")
-//         // "detekt-baseline.xml"
-//         dependencies {
-//             detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:1.23.1")
-//         }
-//     }
+dependencies {
+    detektPlugins("io.gitlab.arturbosch.detekt:detekt-formatting:${libs.versions.detekt.get()}")
+}
+
+// config detekt
+detekt {
+    source.setFrom(subprojects.map { it.projectDir.absoluteFile })
+    config.setFrom(rootDir.resolve("config/detekt/detekt.yml"))
+    baseline = rootDir.resolve("config/detekt/baseline.xml")
+    // buildUponDefaultConfig = true
+    parallel = true
+    reportsDir = rootProject.layout.buildDirectory.dir("reports/detekt").get().asFile
+    if (!isCi) {
+        autoCorrect = true
+    }
+    basePath = projectDir.absolutePath
+}
+
+// https://detekt.dev/blog/2019/03/03/configure-detekt-on-root-project/
+tasks.withType<Detekt>().configureEach {
+    // internal 处理器不管
+    exclude("internal-processors/**")
+
+    include("**/src/*Main/kotlin/**/*.kt")
+    include("**/src/*Main/kotlin/**/*.java")
+    include("**/src/*Main/java/**/*.kt")
+    include("**/src/*Main/java/**/*.java")
+    include("**/src/main/kotlin/**/*.kt")
+    include("**/src/main/kotlin/**/*.java")
+    include("**/src/main/java/**/*.kt")
+    include("**/src/main/java/**/*.java")
+
+    exclude("**/src/*/resources/")
+    exclude("**/build/")
+    exclude("**/*Test/kotlin/")
+    exclude("**/*Test/java/")
+    exclude("**/test/kotlin/")
+    exclude("**/test/java/")
 }
 
 fun Project.applyKover(rp: Project) {
-    val hasKt = (plugins.hasPlugin("org.jetbrains.kotlin.jvm")
-            || plugins.hasPlugin("org.jetbrains.kotlin.multiplatform"))
+    val hasKt =
+        plugins.hasPlugin("org.jetbrains.kotlin.jvm") ||
+            plugins.hasPlugin("org.jetbrains.kotlin.multiplatform")
+
 
     if (hasKt) {
         apply(plugin = "org.jetbrains.kotlinx.kover")

.idea/codeStyles/codeStyleConfig.xml

@@ -4,7 +4,7 @@
  *     Project    https://github.com/simple-robot/simpler-robot
  *     Email      [email protected]
  *
- *     This file is part of the Simple Robot Library.
+ *     This file is part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
  *
  *     This program is free software: you can redistribute it and/or modify
  *     it under the terms of the GNU Lesser General Public License as published by
@@ -47,10 +47,6 @@ dependencies {
 
     // gradle common
     implementation(libs.bundles.gradle.common)
-
-    // detekt
-    // 1.23.1
-    implementation("io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.23.5")
 }
 
 idea {

.idea/runConfigurations/simbot__detekt_.xml

@@ -4,7 +4,7 @@
  *     Project    https://github.com/simple-robot/simpler-robot
  *     Email      [email protected]
  *
- *     This file is part of the Simple Robot Library.
+ *     This file is part of the Simple Robot Library (Alias: simple-robot, simbot, etc.).
  *
  *     This program is free software: you can redistribute it and/or modify
  *     it under the terms of the GNU Lesser General Public License as published by
@@ -26,6 +26,7 @@ import org.gradle.kotlin.dsl.withType
 
 
 fun Project.useK2(languageVersion: String = "2.0") {
+    logger.warn("暂时关闭K2, 等待稳定版。The input languageVersion = {}", languageVersion)
     tasks.withType<org.jetbrains.kotlin.gradle.tasks.KotlinCompile> {
         kotlinOptions {
             // useK2