`nmcpSettings` accessor not available in a settings convention plugin

[bric3]

Expected and Results

I create a settings convention plugin, in order to configure nmcp over there. However, I found out that the nmcpSettings accessor to be not generated.

There is a simple workaround by using

configure<nmcp.internal.DefaultNmcpSettings> { }

But this expose the "internal" type. So I suppose this could be a bug.

Related environment and versions

Gradle 9.2.1, nmcp 1.4.3

Reproduction steps

Here's what I wrote:

./build-settings/src/main/kotlin/fireplace.central-publication.settings.gradle.kts

plugins {
    id("com.gradleup.nmcp.settings")
}

configure<nmcp.internal.DefaultNmcpSettings>() {
    centralPortal {
        username.set(providers.gradleProperty("mavenCentralUsername"))
        //...
    }
}

./gradle/libs.versions.toml

[versions]
nmcp = "1.4.3"

[libraries]
gradlePlugin-nmcp = { module = "com.gradleup.nmcp:nmcp", version.ref = "nmcp" }

`./build-settings/build.gradle.kts

plugins {
    `kotlin-dsl`
}

repositories {
    gradlePluginPortal()
    mavenCentral()
}

dependencies {
    implementation(libs.gradlePlugin.nmcp)
}

./build-settings/settings.gradle.kts

pluginManagement {
    repositories {
        mavenCentral()
        gradlePluginPortal()
    }
}

rootProject.name = "build-settings"

dependencyResolutionManagement {
    repositories {
        gradlePluginPortal()
        mavenCentral()
    }
    versionCatalogs {
        create("libs") {
            from(files("../gradle/libs.versions.toml"))
        }
    }
}

`./settings.gradle.kts

pluginManagement {
    includeBuild("build-settings")
}

plugins {
    id("fireplace.central-publication")
}

Anything else?

No response

[martinbonnin]

Thanks will look into it! To avoid using internal apis, you should be able to do just configure<nmcp.NmcpSettings> {}.

nmcp.internal.DefaultNmcpSettings is indeed the internal implementation and shouldn't be depended on.

[martinbonnin]

This seems to be working in a simple project:

plugins {
  id("com.gradleup.nmcp.settings").version("1.4.3")
}

nmcpSettings {
  centralPortal {
    username.set("foo")
    password.set("bar")
  }
}

I see you're using kotlin-dsl. Is that even supported? accessors in settings plugins? I can't find an example of an open source Settings plugin that generates an accessor. Do you have something around I could take a look at?

[martinbonnin]

Develocity puts its symbols in the org.gradle.kotlin.dsl package which sounds.... not great.

[bric3]

I see you're using kotlin-dsl. Is that even supported? accessors in settings plugins? I can't find an example of an open source Settings plugin that generates an accessor. Do you have something around I could take a look at?

Ah that may be it! I wasn't even aware that accessors were not supported in settings convention plugins 🤔

[martinbonnin]

I have no idea TBH. I'm not touching kotlin-dsl with gloves...

If you find out another plugin works I can look into it but at first sight I don't see anything wrong.

[bric3]

@martinbonnin Thanks for the blog article, it's interesting.

However, for convenience in convention plugins kotlin-dsl "might" still apply ?

[martinbonnin]

I think the convenience part is mostly stockholm syndrome. I won't use kotlin-dsl personally but I know people are using it. If I can make this experience better, I will.