Skip to content

Setup detekt #5312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Setup detekt #5312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d894456
Add Detekt Gradle config
TimoPtr May 15, 2025
48857ea
Add Detekt to Github Action
TimoPtr May 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions .github/workflows/pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,28 @@ jobs:
with:
category: "KTlint"

detekt:
needs: [yamllint, lockfiles]
runs-on: ubuntu-latest
permissions:
security-events: write
steps:
- uses: actions/checkout@v4

- uses: ./.github/actions/setup-build-env
with:
cache-encryption-key: ${{ secrets.GRADLE_ENCRYPTION_KEY }}
mock-google-services: "true"

# Since `build-logic` is added with `includeBuild` we have to call detekt explicitly on `:convention`.
- name: Run detekt
run: ./gradlew detekt :build-logic:convention:detekt --continue

- uses: ./.github/actions/upload-sarif-results
if: always()
with:
category: "Detekt"

lint:
needs: [yamllint, lockfiles]
runs-on: ubuntu-latest
Expand Down Expand Up @@ -102,7 +124,7 @@ jobs:

screenshot_test:
name: "Screenshot Tests"
needs: [lint, lockfiles, ktlint]
needs: [lint, lockfiles, ktlint, detekt]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -171,7 +193,7 @@ jobs:

unit_tests:
name: "Unit Tests"
needs: [lint, lockfiles, ktlint]
needs: [lint, lockfiles, ktlint, detekt]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand All @@ -195,7 +217,7 @@ jobs:

instrumentation_test:
name: "Instrumentation Tests"
needs: [lint, lockfiles, ktlint]
needs: [lint, lockfiles, ktlint, detekt]
runs-on: ubuntu-latest
strategy:
# We want the result of each device to be reported, so we can't fail-fast
Expand Down
25 changes: 25 additions & 0 deletions .idea/runConfigurations/Detekt.xml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

56 changes: 47 additions & 9 deletions app/gradle.lockfile
View file
Open in desktop

Large diffs are not rendered by default.

56 changes: 47 additions & 9 deletions automotive/gradle.lockfile
View file
Open in desktop

Large diffs are not rendered by default.

16 changes: 16 additions & 0 deletions build-logic/convention/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,19 @@

import io.gitlab.arturbosch.detekt.Detekt
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
import org.jlleitschuh.gradle.ktlint.reporter.ReporterType

plugins {
`kotlin-dsl`
alias(libs.plugins.ktlint)
alias(libs.plugins.detekt)
}

group = "io.homeassistant.companion.android.buildlogic"

allprojects {
apply(plugin = rootProject.libs.plugins.ktlint.get().pluginId)
apply(plugin = rootProject.libs.plugins.detekt.get().pluginId)

ktlint {
android.set(true)
Expand All @@ -24,6 +28,18 @@ allprojects {
exclude { it.file.path.contains("build${File.separator}generated-sources") }
}
}

detekt {
config.setFrom(file("../../config/detekt/detekt.yml"))
buildUponDefaultConfig = true
}

tasks.withType<Detekt>().configureEach {
reports {
html.required.set(true)
sarif.required.set(true)
}
}
}

// Configure the build-logic plugins to target JDK 17 and is not related to what is running on device.
Expand Down
14 changes: 14 additions & 0 deletions build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import io.gitlab.arturbosch.detekt.Detekt
import org.jlleitschuh.gradle.ktlint.reporter.ReporterType

plugins {
alias(libs.plugins.ktlint)
alias(libs.plugins.detekt)

alias(libs.plugins.android.application).apply(false)
alias(libs.plugins.android.library).apply(false)
Expand All @@ -16,6 +18,7 @@ plugins {

allprojects {
apply(plugin = rootProject.libs.plugins.ktlint.get().pluginId)
apply(plugin = rootProject.libs.plugins.detekt.get().pluginId)

ktlint {
android.set(true)
Expand All @@ -25,6 +28,17 @@ allprojects {
}
}

detekt {
buildUponDefaultConfig = true
}

tasks.withType<Detekt>().configureEach {
reports {
html.required.set(true)
sarif.required.set(true)
}
}

dependencyLocking {
lockAllConfigurations()
}
Expand Down
54 changes: 47 additions & 7 deletions common/gradle.lockfile
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions config/detekt/detekt.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
style:
MaxLineLength:
active: true
maxLineLength: 120
excludePackageStatements: true
excludeImportStatements: true
excludeCommentStatements: false
excludeRawStrings: true
54 changes: 47 additions & 7 deletions gradle.lockfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,26 +19,66 @@ com.pinterest.ktlint:ktlint-rule-engine-core:1.0.1=ktlint,ktlintBaselineReporter
com.pinterest.ktlint:ktlint-rule-engine:1.0.1=ktlint
com.pinterest.ktlint:ktlint-ruleset-standard:1.0.1=ktlint,ktlintRuleset
dev.drewhamilton.poko:poko-annotations-jvm:0.15.0=ktlint,ktlintBaselineReporter,ktlintRuleset
dev.drewhamilton.poko:poko-annotations-jvm:0.17.1=detekt
dev.drewhamilton.poko:poko-annotations:0.15.0=ktlint,ktlintBaselineReporter,ktlintRuleset
dev.drewhamilton.poko:poko-annotations:0.17.1=detekt
info.picocli:picocli:4.7.5=ktlint
io.github.davidburstrom.contester:contester-breakpoint:0.2.0=detekt
io.github.detekt.sarif4k:sarif4k-jvm:0.5.0=ktlint,ktlintReporter
io.github.detekt.sarif4k:sarif4k-jvm:0.6.0=detekt
io.github.detekt.sarif4k:sarif4k:0.5.0=ktlint,ktlintReporter
io.github.detekt.sarif4k:sarif4k:0.6.0=detekt
io.github.oshai:kotlin-logging-jvm:5.1.0=ktlint,ktlintBaselineReporter,ktlintReporter,ktlintRuleset
io.github.oshai:kotlin-logging:5.1.0=ktlint,ktlintBaselineReporter,ktlintReporter
io.gitlab.arturbosch.detekt:detekt-api:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-cli:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-core:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-metrics:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-parser:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-psi-utils:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-report-html:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-report-md:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-report-sarif:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-report-txt:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-report-xml:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules-complexity:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules-coroutines:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules-documentation:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules-empty:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules-errorprone:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules-exceptions:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules-naming:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules-performance:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules-style:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-rules:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-tooling:1.23.8=detekt
io.gitlab.arturbosch.detekt:detekt-utils:1.23.8=detekt
org.ec4j.core:ec4j-core:0.3.0=ktlint,ktlintBaselineReporter,ktlintRuleset
org.jetbrains.intellij.deps:trove4j:1.0.20200330=ktlint,ktlintBaselineReporter,ktlintRuleset
org.jcommander:jcommander:1.85=detekt
org.jetbrains.intellij.deps:trove4j:1.0.20200330=detekt,ktlint,ktlintBaselineReporter,ktlintRuleset
org.jetbrains.kotlin:kotlin-compiler-embeddable:1.9.10=ktlint,ktlintBaselineReporter,ktlintRuleset
org.jetbrains.kotlin:kotlin-compiler-embeddable:2.0.21=detekt
org.jetbrains.kotlin:kotlin-daemon-embeddable:1.9.10=ktlint,ktlintBaselineReporter,ktlintRuleset
org.jetbrains.kotlin:kotlin-daemon-embeddable:2.0.21=detekt
org.jetbrains.kotlin:kotlin-reflect:1.6.10=ktlint,ktlintBaselineReporter,ktlintRuleset
org.jetbrains.kotlin:kotlin-reflect:2.0.21=detekt
org.jetbrains.kotlin:kotlin-script-runtime:1.9.10=ktlint,ktlintBaselineReporter,ktlintRuleset
org.jetbrains.kotlin:kotlin-script-runtime:2.0.21=detekt
org.jetbrains.kotlin:kotlin-stdlib-common:1.9.10=ktlint,ktlintBaselineReporter,ktlintReporter,ktlintRuleset
org.jetbrains.kotlin:kotlin-stdlib-common:2.0.21=detekt
org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.8.0=detekt
org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.9.10=ktlint,ktlintBaselineReporter,ktlintReporter,ktlintRuleset
org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.8.0=detekt
org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.9.10=ktlint,ktlintBaselineReporter,ktlintReporter,ktlintRuleset
org.jetbrains.kotlin:kotlin-stdlib:1.9.10=ktlint,ktlintBaselineReporter,ktlintReporter,ktlintRuleset
org.jetbrains.kotlinx:kotlinx-serialization-core-jvm:1.4.1=ktlintReporter
org.jetbrains.kotlinx:kotlinx-serialization-core:1.4.1=ktlintReporter
org.jetbrains.kotlinx:kotlinx-serialization-json-jvm:1.4.1=ktlintReporter
org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1=ktlintReporter
org.jetbrains:annotations:13.0=ktlint,ktlintBaselineReporter,ktlintReporter,ktlintRuleset
org.jetbrains.kotlin:kotlin-stdlib:2.0.21=detekt
org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.4=detekt
org.jetbrains.kotlinx:kotlinx-html-jvm:0.8.1=detekt
org.jetbrains.kotlinx:kotlinx-serialization-core-jvm:1.4.1=detekt,ktlintReporter
org.jetbrains.kotlinx:kotlinx-serialization-core:1.4.1=detekt,ktlintReporter
org.jetbrains.kotlinx:kotlinx-serialization-json-jvm:1.4.1=detekt,ktlintReporter
org.jetbrains.kotlinx:kotlinx-serialization-json:1.4.1=detekt,ktlintReporter
org.jetbrains:annotations:13.0=detekt,ktlint,ktlintBaselineReporter,ktlintReporter,ktlintRuleset
org.slf4j:slf4j-api:2.0.4=ktlint
empty=
org.snakeyaml:snakeyaml-engine:2.7=detekt
empty=detektPlugins
2 changes: 2 additions & 0 deletions gradle/libs.versions.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ coreKtx = "1.16.0"
core-splashscreen = "1.1.0-rc01"
core-remoteviews = "1.1.0"
cronet-embedded = "119.6045.31"
detekt = "1.23.8"
emojiJava = "5.1.1"
firebase-bom = "33.13.0"
firebaseAppdistributionGradle = "5.1.1"
Expand Down Expand Up @@ -89,6 +90,7 @@ zxing = "4.3.0"
[plugins]
android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }
android-library = { id = "com.android.library", version.ref = "androidGradlePlugin" }
detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }
firebase-appdistribution = { id = "com.google.firebase.appdistribution", version.ref = "firebaseAppdistributionGradle" }
google-services = { id = "com.google.gms.google-services", version.ref = "googleServices" }
hilt = { id = "com.google.dagger.hilt.android", version.ref = "hilt" }
Expand Down
Loading
Loading