-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
KotlinSettingsScriptTemplate.kt
78 lines (70 loc) · 2.78 KB
/
KotlinSettingsScriptTemplate.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
/*
* Copyright 2023 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.kotlin.dsl
import org.gradle.api.Incubating
import org.gradle.api.initialization.Settings
import org.gradle.api.initialization.dsl.ScriptHandler
import org.gradle.api.plugins.PluginAware
import org.gradle.kotlin.dsl.resolver.KotlinBuildScriptDependenciesResolver
import org.gradle.kotlin.dsl.support.DefaultKotlinScript
import org.gradle.kotlin.dsl.support.KotlinScriptHost
import org.gradle.kotlin.dsl.support.defaultKotlinScriptHostForSettings
import org.gradle.plugin.use.PluginDependenciesSpec
import kotlin.script.experimental.annotations.KotlinScript
import kotlin.script.experimental.api.baseClass
import kotlin.script.experimental.api.filePathPattern
import kotlin.script.experimental.api.implicitReceivers
import kotlin.script.templates.ScriptTemplateDefinition
private
class KotlinSettingsScriptTemplateCompilationConfiguration : KotlinDslStandaloneScriptCompilationConfiguration({
filePathPattern.put("(?:.+\\.)?settings\\.gradle\\.kts")
baseClass(KotlinSettingsScriptTemplate::class)
implicitReceivers(Settings::class)
})
/**
* Base class for Gradle Kotlin DSL standalone [Settings] scripts IDE support.
*
* @since 8.1
*/
@Incubating
@KotlinScript(
compilationConfiguration = KotlinSettingsScriptTemplateCompilationConfiguration::class
)
@ScriptTemplateDefinition(
resolver = KotlinBuildScriptDependenciesResolver::class,
)
@GradleDsl
abstract class KotlinSettingsScriptTemplate(
private val host: KotlinScriptHost<Settings>
) : DefaultKotlinScript(defaultKotlinScriptHostForSettings(host.target)), PluginAware by host.target {
/**
* The [ScriptHandler] for this script.
*/
fun getBuildscript(): ScriptHandler =
host.scriptHandler
/**
* Configures the plugin dependencies for the project's settings.
*
* @see [PluginDependenciesSpec]
* @since 6.0
*/
@Suppress("unused")
open fun plugins(@Suppress("unused_parameter") block: PluginDependenciesSpecScope.() -> Unit): Unit =
throw Exception(
"The plugins {} block must not be used here. "
+ "If you need to apply a plugin imperatively, please use apply<PluginType>() or apply(plugin = \"id\") instead."
)
}