Plugins that make working with Gradle simpler (#101)

eygraber · Dec 27, 2022 · 7114807 · 7114807
1 parent 1568275
commit 7114807
Show file tree

Hide file tree

Showing 38 changed files with 1,451 additions and 69 deletions.
diff --git a/.ci-java-version b/.ci-java-version
@@ -0,0 +1 @@
+17
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -7,10 +7,10 @@ jobs:
   danger:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
+      - uses: actions/checkout@v3
 
       - name: Danger
-        uses: docker://ghcr.io/danger/danger-kotlin:1.1.0
+        uses: docker://ghcr.io/danger/danger-kotlin:1.2.0
         with:
           args: --failOnErrors --no-publish-check
         env:
@@ -19,25 +19,25 @@ jobs:
   no_accessors:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
+      - uses: actions/checkout@v3
 
       - name: Don't allow any accessor imports
         run: if grep --include=\*.{kt,kts} -rne 'import gradle\.kotlin\.dsl\.accessors\._' .; then false; else true; fi
 
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-java@1df8dbefe2a8cbc99770194893dd902763bee34b
+      - uses: actions/setup-java@v3.9.0
         with:
           distribution: 'zulu'
-          java-version: 17
+          java-version-file: .ci-java-version
 
-      - uses: gradle/wrapper-validation-action@55e685c48d84285a5b0418cd094606e199cca3b6
+      - uses: gradle/wrapper-validation-action@v1
 
       - name: Setup Gradle
-        uses: gradle/gradle-build-action@3fbe033aaae657f011f88f29be9e65ed26bd29ef
+        uses: gradle/gradle-build-action@v2
         with:
           gradle-version: wrapper
 
@@ -47,22 +47,22 @@ jobs:
   detektWithTypeResolution:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-java@1df8dbefe2a8cbc99770194893dd902763bee34b
+      - uses: actions/setup-java@v3.9.0
         with:
           distribution: 'zulu'
-          java-version: 17
+          java-version-file: .ci-java-version
 
-      - uses: gradle/wrapper-validation-action@55e685c48d84285a5b0418cd094606e199cca3b6
+      - uses: gradle/wrapper-validation-action@v1
 
       - name: Setup Gradle
-        uses: gradle/gradle-build-action@3fbe033aaae657f011f88f29be9e65ed26bd29ef
+        uses: gradle/gradle-build-action@v2
         with:
           gradle-version: wrapper
 
       - name: Ensure project builds
-        run: ./gradlew detektMain
+        run: ./gradlew :utils-base:detektMain :utils-detekt:detektMain :utils-kotlin:detektMain
 
 
 env:

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -16,24 +16,24 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
+      - uses: actions/checkout@v3
 
       - name: Generate versions
-        uses: HardNorth/github-version-generate@91998704a2b37be20604933d9c989ebade9c5f89
+        uses: HardNorth/github-version-generate@v1.3.0
         with:
           version-source: file
           version-file: ${{ env.VERSION_FILE }}
           version-file-extraction-pattern: ${{ env.VERSION_EXTRACT_PATTERN }}
 
-      - uses: actions/setup-java@1df8dbefe2a8cbc99770194893dd902763bee34b
+      - uses: actions/setup-java@v3.9.0
         with:
           distribution: 'zulu'
-          java-version: 17
+          java-version-file: .ci-java-version
 
-      - uses: gradle/wrapper-validation-action@55e685c48d84285a5b0418cd094606e199cca3b6
+      - uses: gradle/wrapper-validation-action@v1
 
       - name: Setup Gradle
-        uses: gradle/gradle-build-action@3fbe033aaae657f011f88f29be9e65ed26bd29ef
+        uses: gradle/gradle-build-action@v2
         with:
           gradle-version: wrapper
 
@@ -45,7 +45,7 @@ jobs:
         run: ./gradlew publish -PVERSION_NAME=${{ env.RELEASE_VERSION }}
 
       - name: Import GPG Key
-        uses: crazy-max/ghaction-import-gpg@111c56156bcc6918c056dbef52164cfa583dc549
+        uses: crazy-max/ghaction-import-gpg@v5.2.0
         with:
           gpg_private_key: ${{ secrets.GIT_SIGNING_PRIVATE_KEY }}
           passphrase: ${{ secrets.GIT_SIGNING_PRIVATE_KEY_PASSWORD }}
@@ -55,7 +55,7 @@ jobs:
 
       - name: Create tag
         id: create_tag
-        uses: actions/github-script@d556feaca394842dc55e4734bf3bb9f685482fa0
+        uses: actions/github-script@v6
         with:
           script: |
             github.rest.git.createRef({
@@ -67,7 +67,7 @@ jobs:
 
       - name: Build changelog
         id: build_changelog
-        uses: mikepenz/release-changelog-builder-action@d0814e580b0dffbc99d2b25e54cd42d2eb533a97
+        uses: mikepenz/release-changelog-builder-action@v3
         with:
           configuration: "changelog_config.json"
           toTag: ${{ env.RELEASE_VERSION }}
@@ -76,15 +76,15 @@ jobs:
 
       - name: Create release
         id: create_release
-        uses: ncipollo/release-action@a2e71bdd4e7dab70ca26a852f29600c98b33153e
+        uses: ncipollo/release-action@v1.12.0
         with:
           body: ${{ steps.build_changelog.outputs.changelog }}
           commit: release
           name: Release ${{ env.RELEASE_VERSION }}
           tag: ${{ env.RELEASE_VERSION }}
           token: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
+      - uses: actions/checkout@v3
         with:
           ref: 'master'
           token: ${{ secrets.PUSH_PAT }}

diff --git a/.github/workflows/publish_snapshot.yml b/.github/workflows/publish_snapshot.yml
@@ -10,17 +10,17 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@755da8c3cf115ac066823e79a1e1788f8940201b
+      - uses: actions/checkout@v3
 
-      - uses: actions/setup-java@1df8dbefe2a8cbc99770194893dd902763bee34b
+      - uses: actions/setup-java@v3.9.0
         with:
           distribution: 'zulu'
-          java-version: 17
+          java-version-file: .ci-java-version
 
-      - uses: gradle/wrapper-validation-action@55e685c48d84285a5b0418cd094606e199cca3b6
+      - uses: gradle/wrapper-validation-action@v1
 
       - name: Setup Gradle
-        uses: gradle/gradle-build-action@3fbe033aaae657f011f88f29be9e65ed26bd29ef
+        uses: gradle/gradle-build-action@v2
         with:
           gradle-version: wrapper
 

diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,4 +1,10 @@
 [versions]
+android-cacheFix = "2.6.0"
+
+android-plugin = "8.0.0-alpha10"
+
+compose-jetbrains = "1.2.2"
+
 detekt = "1.22.0"
 detektEygraber = "1.0.11"
 
@@ -22,9 +28,13 @@ kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 publish = { id = "com.vanniktech.maven.publish", version.ref = "publish" }
 
 [libraries]
+buildscript-android = { module = "com.android.tools.build:gradle", version.ref = "android-plugin" }
+buildscript-androidCacheFix = { module = "gradle.plugin.org.gradle.android:android-cache-fix-gradle-plugin", version.ref = "android-cacheFix" }
+buildscript-compose-jetbrains = { module = "org.jetbrains.compose:compose-gradle-plugin", version.ref = "compose-jetbrains" }
 buildscript-detekt = { module = "io.gitlab.arturbosch.detekt:detekt-gradle-plugin", version.ref = "detekt" }
 buildscript-dokka = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "dokka" }
 buildscript-ejson = { module = "com.eygraber:ejson-gradle", version.ref = "ejson" }
+buildscript-foojay = "org.gradle.toolchains:foojay-resolver:0.4.0"
 buildscript-kotlin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 buildscript-publish = { module = "com.vanniktech:gradle-maven-publish-plugin", version.ref = "publish" }
 buildscript-utils-detekt = { module = "com.eygraber:gradle-utils-detekt", version.ref = "gradleUtils" }

diff --git a/renovate.json b/renovate.json
@@ -2,7 +2,7 @@
   "extends": [
     "config:base"
   ],
-  "enabledManagers": ["gradle"],
+  "enabledManagers": ["gradle", "gradle-wrapper", "github-actions"],
   "labels": ["dependencies"],
   "prHourlyLimit": 3
 }
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -9,6 +9,11 @@ pluginManagement {
     }
     gradlePluginPortal()
     mavenCentral()
+    maven("https://maven.pkg.jetbrains.space/public/p/compose/dev") {
+      content {
+        includeGroupByRegex("org\\.jetbrains\\.compose.*")
+      }
+    }
   }
 }
 

diff --git a/utils-detekt/src/main/kotlin/com/eygraber/gradle/detekt/detekt.kt b/utils-detekt/src/main/kotlin/com/eygraber/gradle/detekt/detekt.kt
@@ -4,22 +4,38 @@ import io.gitlab.arturbosch.detekt.Detekt
 import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 import org.gradle.api.Action
 import org.gradle.api.Project
+import org.gradle.api.file.ConfigurableFileCollection
 import org.gradle.api.plugins.ExtensionAware
 import org.gradle.api.provider.Provider
 import org.gradle.internal.Actions
-import java.io.File
 
 public fun Project.configureDetekt(
   jdkVersion: Provider<String>,
-  configFile: File = File("$rootDir/detekt.yml"),
+  useRootConfigFile: Boolean = true,
+  useProjectConfigFile: Boolean = true,
+  configFiles: ConfigurableFileCollection = files(),
+  ignoredAndroidFlavors: List<String> = emptyList(),
+  ignoredAndroidVariants: List<String> = emptyList(),
   configure: Action<DetektExtension> = Actions.doNothing()
 ) {
-  configureDetekt(jdkVersion.get(), configFile, configure)
+  configureDetekt(
+    jdkVersion.get(),
+    useRootConfigFile,
+    useProjectConfigFile,
+    configFiles,
+    ignoredAndroidFlavors,
+    ignoredAndroidVariants,
+    configure
+  )
 }
 
 public fun Project.configureDetekt(
   jdkVersion: String,
-  configFile: File = File("$rootDir/detekt.yml"),
+  useRootConfigFile: Boolean = true,
+  useProjectConfigFile: Boolean = true,
+  configFiles: ConfigurableFileCollection = files(),
+  ignoredAndroidFlavors: List<String> = emptyList(),
+  ignoredAndroidVariants: List<String> = emptyList(),
   configure: Action<DetektExtension> = Actions.doNothing()
 ) {
   detekt {
@@ -30,14 +46,33 @@ public fun Project.configureDetekt(
 
     buildUponDefaultConfig = true
 
-    config = files(configFile)
+    config = configFiles.apply {
+      val rootConfig = rootProject.file("detekt.yml")
+      if(useRootConfigFile && rootConfig.exists()) {
+        from(rootConfig)
+      }
+
+      val projectConfig = project.file("detekt.yml")
+      if(useProjectConfigFile && projectConfig.exists()) {
+        from(projectConfig)
+      }
+    }
+
+    ignoredFlavors = ignoredFlavors + ignoredAndroidFlavors
+    ignoredVariants = ignoredVariants + ignoredAndroidVariants
 
     configure.execute(this)
   }
 
   tasks.withType(Detekt::class.java).configureEach {
     // Target version of the generated JVM bytecode. It is used for type resolution.
     jvmTarget = jdkVersion
+    val projectDir = projectDir
+    val buildDir = project.buildDir
+
+    exclude {
+      it.file.relativeTo(projectDir).startsWith(buildDir.relativeTo(projectDir))
+    }
   }
 }
 

diff --git a/utils-detekt/src/main/kotlin/com/eygraber/gradle/detekt/detekt_common_test.kt b/utils-detekt/src/main/kotlin/com/eygraber/gradle/detekt/detekt_common_test.kt
@@ -2,13 +2,20 @@ package com.eygraber.gradle.detekt
 
 import com.eygraber.gradle.kotlin.kmp.kmpSourceSets
 import org.gradle.api.Project
+import org.gradle.api.UnknownTaskException
 import org.jetbrains.kotlin.gradle.plugin.KotlinMultiplatformPluginWrapper
 
 public fun Project.registerCommonTestDetektTask() {
   plugins.withType(KotlinMultiplatformPluginWrapper::class.java) {
-    registerDetektTask(
-      name = "metadataTest",
-      sourceSet = kmpSourceSets.getByName("commonTest")
-    )
+    try {
+      tasks.named("detektMetadataTest")
+    }
+    catch(_: UnknownTaskException) {
+      // only register the task if it hasn't already been registered
+      registerDetektTask(
+        name = "metadataTest",
+        sourceSet = kmpSourceSets.getByName("commonTest")
+      )
+    }
   }
 }
diff --git a/utils-kotlin/src/main/kotlin/com/eygraber/gradle/kotlin/KotlinFreeCompilerArg.kt b/utils-kotlin/src/main/kotlin/com/eygraber/gradle/kotlin/KotlinFreeCompilerArg.kt
@@ -0,0 +1,5 @@
+package com.eygraber.gradle.kotlin
+
+public sealed class KotlinFreeCompilerArg(public val value: String) {
+  public class Unknown(value: String) : KotlinFreeCompilerArg(value)
+}
diff --git a/utils-kotlin/src/main/kotlin/com/eygraber/gradle/kotlin/KotlinOptIn.kt b/utils-kotlin/src/main/kotlin/com/eygraber/gradle/kotlin/KotlinOptIn.kt
@@ -0,0 +1,10 @@
+package com.eygraber.gradle.kotlin
+
+public sealed class KotlinOptIn(public val value: String) {
+  public object ExperimentalCoroutines : KotlinOptIn("kotlinx.coroutines.ExperimentalCoroutinesApi")
+  public object ExperimentalTime : KotlinOptIn("kotlin.time.ExperimentalTime")
+  public object FlowPreview : KotlinOptIn("kotlinx.coroutines.FlowPreview")
+  public object JsExport : KotlinOptIn("kotlin.js.ExperimentalJsExport")
+  public object RequiresOptIn : KotlinOptIn("kotlin.RequiresOptIn")
+  public class Unknown(value: String) : KotlinOptIn(value)
+}
diff --git a/utils-kotlin/src/main/kotlin/com/eygraber/gradle/kotlin/dependencies.kt b/utils-kotlin/src/main/kotlin/com/eygraber/gradle/kotlin/dependencies.kt
@@ -0,0 +1,21 @@
+package com.eygraber.gradle.kotlin
+
+import org.gradle.api.Project
+import org.gradle.api.artifacts.Dependency
+
+public fun Project.doOnFirstMatchingIncomingDependencyBeforeResolution(
+  configurationName: String,
+  dependencyPredicate: Dependency.() -> Boolean,
+  onMatch: (Dependency) -> Unit
+) {
+  configurations.named(configurationName).configure {
+    incoming.beforeResolve {
+      for(dependency in dependencies) {
+        if(dependencyPredicate(dependency)) {
+          onMatch(dependency)
+          break
+        }
+      }
+    }
+  }
+}