build(Gradle): Use conventions to opt-in to `ExperimentalSerializatio…

…nApi` This reduces code duplication and bundles `-opt-in` arguments. Signed-off-by: Sebastian Schuberth <[email protected]>
oss-review-toolkit · Feb 20, 2024 · 15b4ee1 · 15b4ee1
1 parent 5457ed0
commit 15b4ee1
Show file tree

Hide file tree

Showing 21 changed files with 8 additions and 245 deletions.
diff --git a/buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts b/buildSrc/src/main/kotlin/ort-kotlin-conventions.gradle.kts
@@ -157,11 +157,14 @@ tasks.withType<JavaCompile>().configureEach {
 }
 
 tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlin.contracts.ExperimentalContracts",
-        "-opt-in=kotlin.io.path.ExperimentalPathApi",
-        "-opt-in=kotlin.time.ExperimentalTime"
-    )
+    val hasSerialization = plugins.hasPlugin(libs.plugins.kotlinSerialization.get().pluginId)
+
+    val customCompilerArgs = buildList {
+        add("-opt-in=kotlin.contracts.ExperimentalContracts")
+        add("-opt-in=kotlin.io.path.ExperimentalPathApi")
+        add("-opt-in=kotlin.time.ExperimentalTime")
+        if (hasSerialization) add("-opt-in=kotlinx.serialization.ExperimentalSerializationApi")
+    }
 
     compilerOptions {
         allWarningsAsErrors = true

diff --git a/clients/clearly-defined/build.gradle.kts b/clients/clearly-defined/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -36,13 +34,3 @@ dependencies {
     implementation(libs.retrofit.converter.kotlinxSerialization)
     implementation(libs.retrofit.converter.scalars)
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/clients/nexus-iq/build.gradle.kts b/clients/nexus-iq/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -34,13 +32,3 @@ dependencies {
     implementation(libs.bundles.kotlinxSerialization)
     implementation(libs.retrofit.converter.kotlinxSerialization)
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/clients/osv/build.gradle.kts b/clients/osv/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -37,13 +35,3 @@ dependencies {
 
     testImplementation(libs.kotest.assertions.json)
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/clients/scanoss/build.gradle.kts b/clients/scanoss/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -36,13 +34,3 @@ dependencies {
 
     testImplementation(libs.wiremock)
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/clients/vulnerable-code/build.gradle.kts b/clients/vulnerable-code/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -34,13 +32,3 @@ dependencies {
     implementation(libs.bundles.kotlinxSerialization)
     implementation(libs.retrofit.converter.kotlinxSerialization)
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/evaluator/build.gradle.kts b/evaluator/build.gradle.kts
@@ -19,8 +19,6 @@
 
 import de.undercouch.gradle.tasks.download.Download
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -45,16 +43,6 @@ dependencies {
     testImplementation(libs.mockk)
 }
 
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
-
 tasks.register<Download>("updateOsadlMatrix") {
     description = "Download the OSADL matrix in JSON format and add it as a resource."
     group = "OSADL"

diff --git a/plugins/advisors/osv/build.gradle.kts b/plugins/advisors/osv/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -35,13 +33,3 @@ dependencies {
     implementation(libs.cvssCalculator)
     implementation(libs.bundles.kotlinxSerialization)
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/plugins/package-managers/cargo/build.gradle.kts b/plugins/package-managers/cargo/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -47,13 +45,3 @@ dependencies {
 
     funTestImplementation(testFixtures(projects.analyzer))
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/plugins/package-managers/go/build.gradle.kts b/plugins/package-managers/go/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -47,13 +45,3 @@ dependencies {
 
     funTestImplementation(testFixtures(projects.analyzer))
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/plugins/package-managers/nuget/build.gradle.kts b/plugins/package-managers/nuget/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -41,13 +39,3 @@ dependencies {
 
     funTestImplementation(testFixtures(projects.analyzer))
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/plugins/package-managers/python/build.gradle.kts b/plugins/package-managers/python/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -46,13 +44,3 @@ dependencies {
 
     funTestImplementation(testFixtures(projects.analyzer))
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/plugins/package-managers/swiftpm/build.gradle.kts b/plugins/package-managers/swiftpm/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -46,13 +44,3 @@ dependencies {
 
     funTestImplementation(testFixtures(projects.analyzer))
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/plugins/reporters/ctrlx/build.gradle.kts b/plugins/reporters/ctrlx/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -38,13 +36,3 @@ dependencies {
 
     funTestImplementation(testFixtures(projects.reporter))
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/plugins/reporters/gitlab/build.gradle.kts b/plugins/reporters/gitlab/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -37,13 +35,3 @@ dependencies {
 
     implementation(libs.bundles.kotlinxSerialization)
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/plugins/reporters/trustsource/build.gradle.kts b/plugins/reporters/trustsource/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -42,13 +40,3 @@ dependencies {
 
     funTestImplementation(libs.kotest.assertions.json)
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}
diff --git a/plugins/scanners/askalono/build.gradle.kts b/plugins/scanners/askalono/build.gradle.kts
@@ -17,8 +17,6 @@
  * License-Filename: LICENSE
  */
 
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
 plugins {
     // Apply precompiled plugins.
     id("ort-library-conventions")
@@ -35,13 +33,3 @@ dependencies {
 
     funTestApi(testFixtures(projects.scanner))
 }
-
-tasks.withType<KotlinCompile>().configureEach {
-    val customCompilerArgs = listOf(
-        "-opt-in=kotlinx.serialization.ExperimentalSerializationApi"
-    )
-
-    compilerOptions {
-        freeCompilerArgs.addAll(customCompilerArgs)
-    }
-}