约定插件错误 org.gradle.accessors.dm.LibrariesForDeps 不存在

Question

我正在尝试为通用配置构建约定插件，例如 ktlint。 它们存储在 build-configuration/plugin/convention 下。

class KtlintConventionPlugin : Plugin<Project> {

   override fun apply(target: Project) {
      return with(target) {
         pluginManager.apply(deps.plugins.ktlint.get().pluginId)

         extensions.configure<KtlintExtension> {
            // ...
         }
      }
   }
}

构建配置/插件/约定/build.gradle.kts

plugins {
   `kotlin-dsl`
}

group = "com.example"

dependencies {
   compileOnly(deps.kotlin.jvm.gradle.plugin)
   compileOnly(deps.ktor.gradle.plugin)
   compileOnly(deps.ktlint.gradle.plugin)

   compileOnly(files(deps.javaClass.superclass.protectionDomain.codeSource.location))
}

gradlePlugin {
   plugins {
      register("ktlint-plugin") {
         id = "ktlint-plugin"
         implementationClass = "KtlintConventionPlugin"
      }
   }
}

我还有一个扩展名 function 以获取在build-configuration/plugin/convention/src/main/kotlin/com/example/VersionCatalog.kt中的 TOML 文件（存储在gradle/deps.versions.toml中）中定义的依赖项

import org.gradle.accessors.dm.LibrariesForDeps
import org.gradle.api.Project
import org.gradle.kotlin.dsl.the

internal val Project.deps: LibrariesForDeps
   get() = the()

构建配置/settings.gradle.kts

dependencyResolutionManagement {
   repositories {
      gradlePluginPortal()
      mavenLocal()
      mavenCentral()
   }
   versionCatalogs {
      create("deps") {
         from(files("../gradle/deps.versions.toml"))
      }
   }
}
rootProject.name = "build-configuration"
include(":plugin:convention")

当我在根build.gradle.kts中包含ktlint插件时，Gradle 同步总是失败。

An exception occurred applying plugin request [id: 'ktlint-plugin']
> Failed to apply plugin 'ktlint-plugin'.
   > Type org.gradle.accessors.dm.LibrariesForDeps not present

我可以在 .gradle/.../LibrariesForDeps 中看到生成的 class，但在项目的根目录下，而不是插件的根目录下。

整个构建配置模块包含在 root settings.gradle.kts 中：

includeBuild("build-configuration")

Answer 1

使用libs在约定插件中不起作用，但有一些解决方法： https://github.com/gradle/gradle/issues/15383

但我认为你不需要它。 相反，版本可以在一个地方定义：包含的构建的build.gradle.kts ，它可以访问版本目录 DSL。

1. 在 libs.versions.toml 中定义 ktlint 插件的Maven libs.versions.toml

    [libraries] gradlePlugin-ktlint = { module = "org.jlleitschuh.gradle:ktlint-gradle", version = "11.1.0" }

   我更喜欢在此类依赖项前加上gradlePlugin前缀，以将它们与“常规”项目依赖项区分开来。

   （Maven 坐标在Gradle 插件门户中列出，在“旧版”应用程序下作为classpath依赖项）

2. 在包含的构建中添加对 ktlint 的依赖， build-configuration/build.gradle.kts

    plugins { `kotlin-dsl` } dependencies { implementation(libs.deps.gradlePlugin.ktlint) }

3. 现在 ktlint 插件将在类路径中可用，您可以在约定插件中正常应用它，不需要版本。

   在预编译脚本插件中：

    //./build-configuration/src/main/kotlin/my-ktlint-convention.gradle.kts plugins { id("org.jlleitschuh.gradle.ktlint") // version is provided by build.gradle.kts }

   或者在传统的 class 插件中（需要通过gradlePlugins {}注册）：

    //./build-configuration/src/main/kotlin/KtlintConventionPlugin.kt class KtlintConventionPlugin: Plugin<Project> { override fun apply(target: Project) { target.apply(plugin = "org.jlleitschuh.gradle.ktlint") target.extensions.configure<KtlintExtension> { //... } } }

也可以看看

有关 buildSrc 约定插件的更多信息，这些答案是相关的：

• https://stackoverflow.com/a/71562588/4161471
• https://stackoverflow.com/a/71892685/4161471