Merge pull request #337 from jmfayard/336-plugin-settings

Ensure the plugin is applied in settings.gradle(.kts)

Closes #336

Author: LouisCAD

plugins/dependencies/src/main/kotlin/de/fayard/refreshVersions/RefreshVersionsPlugin.kt

@@ -4,17 +4,14 @@ import de.fayard.refreshVersions.core.RefreshVersionsCorePlugin
 import de.fayard.refreshVersions.core.bootstrapRefreshVersionsCore
 import de.fayard.refreshVersions.core.bootstrapRefreshVersionsCoreForBuildSrc
 import de.fayard.refreshVersions.core.extensions.gradle.isBuildSrc
-import de.fayard.refreshVersions.internal.getArtifactNameToConstantMapping
 import de.fayard.refreshVersions.core.internal.RefreshVersionsConfigHolder
+import de.fayard.refreshVersions.internal.getArtifactNameToConstantMapping
 import org.gradle.api.DefaultTask
 import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.initialization.Settings
-import org.gradle.kotlin.dsl.apply
-import org.gradle.kotlin.dsl.create
-import org.gradle.kotlin.dsl.dependencies
-import org.gradle.kotlin.dsl.getByType
-import org.gradle.kotlin.dsl.register
+import org.gradle.api.invocation.Gradle
+import org.gradle.kotlin.dsl.*
 
 open class RefreshVersionsPlugin : Plugin<Any> {
 
@@ -36,10 +33,21 @@ open class RefreshVersionsPlugin : Plugin<Any> {
 
 
     override fun apply(target: Any) {
-        when (target) {
-            is Settings -> bootstrap(target)
-            is Project -> Unit //TODO: Warn about misconfiguration?
+        require(target is Settings) {
+            val notInExtraClause: String = when (target) {
+                is Project -> when (target) {
+                    target.rootProject -> ", not in build.gradle(.kts)"
+                    else -> ", not in a build.gradle(.kts) file."
+                }
+                is Gradle -> ", not in an initialization script."
+                else -> ""
+            }
+            """
+            plugins.id("de.fayard.refreshVersions") must be configured in settings.gradle(.kts)$notInExtraClause.
+            See https://jmfayard.github.io/refreshVersions/setup/
+            """.trimIndent()
         }
+        bootstrap(target)
     }
 
     private fun bootstrap(settings: Settings) {
@@ -97,7 +105,7 @@ open class RefreshVersionsPlugin : Plugin<Any> {
         ) {
             group = "help"
             description = "Assists migration from hardcoded dependencies to constants of " +
-                    "the refreshVersions dependencies plugin"
+                "the refreshVersions dependencies plugin"
             finalizedBy("refreshVersions")
         }