Gradle 7.2：如何应用自定义 Gradle SETTINGS 插件？

Question

我正在将 buildSrc 约定插件迁移到独立插件中。有很多为 Project 对象创建 Gradle 插件的示例，但真正缺乏 Settings 和 Gradle。我想集中我们在 gradle.settings.kts 文件中使用的存储库列表，因此我创建了一个 Gradle 设置插件：RepositoriesPlugin。

它在项目插件中以相同的方式实现，但是，我不确定如何解释 Gradle 文档中的以下引用：“插件可以接收类型为 Settings 的参数，在这种情况下，插件可以应用于设置脚本。 ”，如以下链接的文档中所述：Gradle 7.2 Doc

以下示例显示了我如何在 settings.gradle.kts 文件中应用设置插件。 根据文档，这是应用设置插件的方式吗？

我也在下面包含了基本设置插件代码。

我非常感谢您的帮助，以澄清我正在正确地执行此操作。我确信这篇文章将帮助那些远离项目插件的人。

感谢您的时间和兴趣..

// settings.gradle.kts

pluginManagement {
    plugins {
        id("com.abitofhelp.gradle.plugins.repositoriesplugin") version "1.0.0-1"
    }

    settings.extensions
        getByType(RepositoriesPluginExtension::class).apply {
            localRepoName = "local-repo"
            localRepositoryPath = "../../local-repo"
        }

    // Set the plugin repositories for all projects.
    //repositories {
    //    maven { name = "localRepo"; url = uri(file("./local-repo")) }
    //    gradlePluginPortal()
    //    mavenCentral()
    //}
}

// repositoriesplugin.kt
open class RepositoriesPlugin: Plugin<Settings> {
    override fun apply(settings: Settings) {
        val extension: RepositoriesPluginExtension =
            settings.extensions.create("repositoriesPlugin", RepositoriesPluginExtension::class.java)

        val localRepositoryName = extension.localRepositoryName?.let { it }?: "../../localRepo"
        val localRepositoryPath = extension.localRepositoryPath?.let { it }?: "../../local-repo"

        settings.pluginManagement.repositories.apply {
            // Set the PLUGIN REPOSITORIES for all subprojects.
            maven { repository ->
                repository.name = localRepositoryName
                repository.url = URI.create(localRepositoryPath)
            }
            gradlePluginPortal()
            mavenCentral()
        }

        settings.dependencyResolutionManagement.repositories.apply {
            // Set the DEPENDENCY REPOSITORIES for all subprojects.
            maven {
                it.name = localRepositoryName
                it.url = URI.create(localRepositoryPath)
            }
            mavenCentral()
            gradlePluginPortal()
        }
    }
}

Answer 1

我相信您需要通过闭包将插件添加到settings.gradle 类路径buildscript中。pluginManagement.plugins使插件可用于根（和子）项目build.gradle类路径，但我认为这是与脚本不同的类路径settings.gradle。

要添加到设置 gradle，请尝试以下操作：

// settings.gradle
    
buildscript {
    repositories {
        maven { url "http://repo.where.plugin.is.published" }
    }

    classpath("complete.maven.coordinates:your-settings-plugin:version")
}

pluginManager.apply(your.settings.plugin.id)