Enable Gradle's type-safe project accessors (#3742)

2026-03-10 08:11:23 +00:00 · 2021-05-07 04:59:44 +10:00
parent 81c9539ecc
commit dc2f3d801c
28 changed files with 102 additions and 101 deletions
--- a/custom-checks/build.gradle.kts
+++ b/custom-checks/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    implementation(project(":detekt-api"))
-    testImplementation(project(":detekt-test"))
+    implementation(projects.detektApi)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-api/build.gradle.kts
+++ b/detekt-api/build.gradle.kts
@@ -9,9 +9,9 @@ plugins {

 dependencies {
    api(libs.kotlin.compilerEmbeddable)
-    api(project(":detekt-psi-utils"))
+    api(projects.detektPsiUtils)

-    testImplementation(project(":detekt-test"))
+    testImplementation(projects.detektTest)

    testFixturesApi(libs.kotlin.stdlibJdk8)

--- a/detekt-cli/build.gradle.kts
+++ b/detekt-cli/build.gradle.kts
@@ -10,12 +10,12 @@ application {

 dependencies {
    implementation(libs.jcommander)
-    implementation(project(":detekt-tooling"))
-    implementation(project(":detekt-parser"))
-    runtimeOnly(project(":detekt-core"))
-    runtimeOnly(project(":detekt-rules"))
+    implementation(projects.detektTooling)
+    implementation(projects.detektParser)
+    runtimeOnly(projects.detektCore)
+    runtimeOnly(projects.detektRules)

-    testImplementation(project(":detekt-test"))
+    testImplementation(projects.detektTest)
 }

 tasks.shadowJar {
--- a/detekt-core/build.gradle.kts
+++ b/detekt-core/build.gradle.kts
@@ -4,17 +4,17 @@ plugins {

 dependencies {
    implementation(libs.snakeyaml)
-    implementation(project(":detekt-api"))
-    implementation(project(":detekt-metrics"))
-    implementation(project(":detekt-parser"))
-    implementation(project(":detekt-psi-utils"))
-    implementation(project(":detekt-tooling"))
-    implementation(project(":detekt-report-html"))
-    implementation(project(":detekt-report-txt"))
-    implementation(project(":detekt-report-xml"))
-    implementation(project(":detekt-report-sarif"))
+    implementation(projects.detektApi)
+    implementation(projects.detektMetrics)
+    implementation(projects.detektParser)
+    implementation(projects.detektPsiUtils)
+    implementation(projects.detektTooling)
+    implementation(projects.detektReportHtml)
+    implementation(projects.detektReportTxt)
+    implementation(projects.detektReportXml)
+    implementation(projects.detektReportSarif)

-    testRuntimeOnly(project(":detekt-rules"))
-    testImplementation(project(":detekt-test"))
-    testImplementation(testFixtures(project(":detekt-api")))
+    testRuntimeOnly(projects.detektRules)
+    testImplementation(projects.detektTest)
+    testImplementation(testFixtures(projects.detektApi))
 }
--- a/detekt-formatting/build.gradle.kts
+++ b/detekt-formatting/build.gradle.kts
@@ -3,7 +3,7 @@ plugins {
 }

 dependencies {
-    implementation(project(":detekt-api"))
+    implementation(projects.detektApi)
    implementation(libs.ktlint.rulesetStandard) {
        exclude(group = "org.jetbrains.kotlin")
    }
@@ -14,7 +14,7 @@ dependencies {
        exclude(group = "org.jetbrains.kotlin")
    }

-    testImplementation(project(":detekt-test"))
+    testImplementation(projects.detektTest)
 }

 tasks.build { finalizedBy(":detekt-generator:generateDocumentation") }
--- a/detekt-generator/build.gradle.kts
+++ b/detekt-generator/build.gradle.kts
@@ -5,14 +5,14 @@ plugins {
 }

 dependencies {
-    implementation(project(":detekt-parser"))
-    implementation(project(":detekt-api"))
-    implementation(project(":detekt-rules-empty"))
-    implementation(project(":detekt-formatting"))
-    implementation(project(":detekt-cli"))
+    implementation(projects.detektParser)
+    implementation(projects.detektApi)
+    implementation(projects.detektRulesEmpty)
+    implementation(projects.detektFormatting)
+    implementation(projects.detektCli)
    implementation(libs.jcommander)

-    testImplementation(project(":detekt-test-utils"))
+    testImplementation(projects.detektTestUtils)
 }

 val documentationDir = "${rootProject.rootDir}/docs/pages/documentation"
--- a/detekt-gradle-plugin/build.gradle.kts
+++ b/detekt-gradle-plugin/build.gradle.kts
@@ -17,7 +17,7 @@ dependencies {
    compileOnly(libs.android.gradlePlugin)
    compileOnly(libs.kotlin.gradlePlugin)

-    testImplementation(project(":detekt-test-utils"))
+    testImplementation(projects.detektTestUtils)
    testImplementation(libs.kotlin.gradlePlugin)
    intTest(libs.kotlin.gradlePlugin)
    intTest(libs.android.gradlePlugin)
--- a/detekt-metrics/build.gradle.kts
+++ b/detekt-metrics/build.gradle.kts
@@ -3,7 +3,7 @@ plugins {
 }

 dependencies {
-    api(project(":detekt-api"))
-    testImplementation(project(":detekt-test-utils"))
-    testImplementation(testFixtures(project(":detekt-api")))
+    api(projects.detektApi)
+    testImplementation(projects.detektTestUtils)
+    testImplementation(testFixtures(projects.detektApi))
 }
--- a/detekt-parser/build.gradle.kts
+++ b/detekt-parser/build.gradle.kts
@@ -6,8 +6,8 @@ plugins {

 dependencies {
    api(libs.kotlin.compilerEmbeddable)
-    implementation(project(":detekt-psi-utils"))
-    testImplementation(project(":detekt-test-utils"))
+    implementation(projects.detektPsiUtils)
+    testImplementation(projects.detektTestUtils)
 }

 tasks.withType<Test> {
--- a/detekt-report-html/build.gradle.kts
+++ b/detekt-report-html/build.gradle.kts
@@ -3,12 +3,12 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    compileOnly(project(":detekt-metrics"))
+    compileOnly(projects.detektApi)
+    compileOnly(projects.detektMetrics)
    implementation(libs.kotlinx.html) {
        exclude(group = "org.jetbrains.kotlin")
    }
-    testImplementation(project(":detekt-metrics"))
-    testImplementation(project(":detekt-test-utils"))
-    testImplementation(testFixtures(project(":detekt-api")))
+    testImplementation(projects.detektMetrics)
+    testImplementation(projects.detektTestUtils)
+    testImplementation(testFixtures(projects.detektApi))
 }
--- a/detekt-report-sarif/build.gradle.kts
+++ b/detekt-report-sarif/build.gradle.kts
@@ -3,10 +3,10 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    compileOnly(project(":detekt-tooling"))
+    compileOnly(projects.detektApi)
+    compileOnly(projects.detektTooling)
    implementation(libs.sarif4k)
-    testImplementation(project(":detekt-tooling"))
-    testImplementation(project(":detekt-test-utils"))
-    testImplementation(testFixtures(project(":detekt-api")))
+    testImplementation(projects.detektTooling)
+    testImplementation(projects.detektTestUtils)
+    testImplementation(testFixtures(projects.detektApi))
 }
--- a/detekt-report-txt/build.gradle.kts
+++ b/detekt-report-txt/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    implementation(project(":detekt-api"))
-    testImplementation(testFixtures(project(":detekt-api")))
+    implementation(projects.detektApi)
+    testImplementation(testFixtures(projects.detektApi))
 }
--- a/detekt-report-xml/build.gradle.kts
+++ b/detekt-report-xml/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    implementation(project(":detekt-api"))
-    testImplementation(testFixtures(project(":detekt-api")))
+    implementation(projects.detektApi)
+    testImplementation(testFixtures(projects.detektApi))
 }
--- a/detekt-rules-complexity/build.gradle.kts
+++ b/detekt-rules-complexity/build.gradle.kts
@@ -3,8 +3,8 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    compileOnly(project(":detekt-metrics"))
-    testImplementation(project(":detekt-metrics"))
-    testImplementation(project(":detekt-test"))
+    compileOnly(projects.detektApi)
+    compileOnly(projects.detektMetrics)
+    testImplementation(projects.detektMetrics)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-rules-coroutines/build.gradle.kts
+++ b/detekt-rules-coroutines/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    testImplementation(project(":detekt-test"))
+    compileOnly(projects.detektApi)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-rules-documentation/build.gradle.kts
+++ b/detekt-rules-documentation/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    testImplementation(project(":detekt-test"))
+    compileOnly(projects.detektApi)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-rules-empty/build.gradle.kts
+++ b/detekt-rules-empty/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    testImplementation(project(":detekt-test"))
+    compileOnly(projects.detektApi)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-rules-errorprone/build.gradle.kts
+++ b/detekt-rules-errorprone/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    testImplementation(project(":detekt-test"))
+    compileOnly(projects.detektApi)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-rules-exceptions/build.gradle.kts
+++ b/detekt-rules-exceptions/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    testImplementation(project(":detekt-test"))
+    compileOnly(projects.detektApi)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-rules-naming/build.gradle.kts
+++ b/detekt-rules-naming/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    testImplementation(project(":detekt-test"))
+    compileOnly(projects.detektApi)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-rules-performance/build.gradle.kts
+++ b/detekt-rules-performance/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    testImplementation(project(":detekt-test"))
+    compileOnly(projects.detektApi)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-rules-style/build.gradle.kts
+++ b/detekt-rules-style/build.gradle.kts
@@ -3,8 +3,8 @@ plugins {
 }

 dependencies {
-    compileOnly(project(":detekt-api"))
-    compileOnly(project(":detekt-metrics"))
-    testImplementation(project(":detekt-metrics"))
-    testImplementation(project(":detekt-test"))
+    compileOnly(projects.detektApi)
+    compileOnly(projects.detektMetrics)
+    testImplementation(projects.detektMetrics)
+    testImplementation(projects.detektTest)
 }
--- a/detekt-rules/build.gradle.kts
+++ b/detekt-rules/build.gradle.kts
@@ -3,27 +3,27 @@ plugins {
 }

 dependencies {
-    runtimeOnly(project(":detekt-rules-complexity"))
-    runtimeOnly(project(":detekt-rules-coroutines"))
-    runtimeOnly(project(":detekt-rules-documentation"))
-    runtimeOnly(project(":detekt-rules-empty"))
-    runtimeOnly(project(":detekt-rules-errorprone"))
-    runtimeOnly(project(":detekt-rules-exceptions"))
-    runtimeOnly(project(":detekt-rules-naming"))
-    runtimeOnly(project(":detekt-rules-performance"))
-    runtimeOnly(project(":detekt-rules-style"))
+    runtimeOnly(projects.detektRulesComplexity)
+    runtimeOnly(projects.detektRulesCoroutines)
+    runtimeOnly(projects.detektRulesDocumentation)
+    runtimeOnly(projects.detektRulesEmpty)
+    runtimeOnly(projects.detektRulesErrorprone)
+    runtimeOnly(projects.detektRulesExceptions)
+    runtimeOnly(projects.detektRulesNaming)
+    runtimeOnly(projects.detektRulesPerformance)
+    runtimeOnly(projects.detektRulesStyle)

-    testImplementation(project(":detekt-core"))
-    testImplementation(project(":detekt-test"))
-    testImplementation(project(":detekt-rules-complexity"))
-    testImplementation(project(":detekt-rules-coroutines"))
-    testImplementation(project(":detekt-rules-documentation"))
-    testImplementation(project(":detekt-rules-empty"))
-    testImplementation(project(":detekt-rules-errorprone"))
-    testImplementation(project(":detekt-rules-exceptions"))
-    testImplementation(project(":detekt-rules-naming"))
-    testImplementation(project(":detekt-rules-performance"))
-    testImplementation(project(":detekt-rules-style"))
+    testImplementation(projects.detektCore)
+    testImplementation(projects.detektTest)
+    testImplementation(projects.detektRulesComplexity)
+    testImplementation(projects.detektRulesCoroutines)
+    testImplementation(projects.detektRulesDocumentation)
+    testImplementation(projects.detektRulesEmpty)
+    testImplementation(projects.detektRulesErrorprone)
+    testImplementation(projects.detektRulesExceptions)
+    testImplementation(projects.detektRulesNaming)
+    testImplementation(projects.detektRulesPerformance)
+    testImplementation(projects.detektRulesStyle)
 }

 tasks.build { finalizedBy(":detekt-generator:generateDocumentation") }
--- a/detekt-sample-extensions/build.gradle.kts
+++ b/detekt-sample-extensions/build.gradle.kts
@@ -5,8 +5,8 @@ plugins {
 dependencies {
    // When creating a sample extension, change this dependency to the detekt-api version you build against
    // e.g. io.gitlab.arturbosch.detekt:detekt-api:1.x.x
-    implementation(project(":detekt-api"))
+    implementation(projects.detektApi)
    // When creating a sample extension, change this dependency to the detekt-test version you build against
    // e.g. io.gitlab.arturbosch.detekt:detekt-test:1.x.x
-    testImplementation(project(":detekt-test"))
+    testImplementation(projects.detektTest)
 }
--- a/detekt-test-utils/build.gradle.kts
+++ b/detekt-test-utils/build.gradle.kts
@@ -5,8 +5,8 @@ plugins {
 dependencies {
    api(libs.kotlin.stdlibJdk8)
    compileOnly(libs.spek.dsl)
-    implementation(project(":detekt-parser"))
-    implementation(project(":detekt-psi-utils"))
+    implementation(projects.detektParser)
+    implementation(projects.detektPsiUtils)
    implementation(libs.kotlin.scriptRuntime)
    implementation(libs.kotlin.scriptUtil)
    implementation(libs.kotlin.scriptingCompilerEmbeddable)
--- a/detekt-test/build.gradle.kts
+++ b/detekt-test/build.gradle.kts
@@ -3,9 +3,9 @@ plugins {
 }

 dependencies {
-    api(project(":detekt-api"))
-    api(project(":detekt-test-utils"))
+    api(projects.detektApi)
+    api(projects.detektTestUtils)
    compileOnly(libs.assertj)
-    implementation(project(":detekt-core"))
-    implementation(project(":detekt-parser"))
+    implementation(projects.detektCore)
+    implementation(projects.detektParser)
 }
--- a/detekt-tooling/build.gradle.kts
+++ b/detekt-tooling/build.gradle.kts
@@ -3,6 +3,6 @@ plugins {
 }

 dependencies {
-    api(project(":detekt-api"))
-    testImplementation(project(":detekt-test-utils"))
+    api(projects.detektApi)
+    testImplementation(projects.detektTestUtils)
 }
--- a/settings.gradle.kts
+++ b/settings.gradle.kts
@@ -32,6 +32,7 @@ include(
 )

 enableFeaturePreview("VERSION_CATALOGS")
+enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")

 // build scan plugin can only be applied in settings file
 plugins {