-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove core interfaces from precompiled Kotlin script template type h…
…ierarchy Support for a common script API will come in a subsequent commit.
- Loading branch information
Showing
10 changed files
with
233 additions
and
87 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
180 changes: 180 additions & 0 deletions
180
...lin-dsl/src/main/kotlin/org/gradle/kotlin/dsl/precompile/v1/PrecompiledScriptTemplates.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| /* | ||
| * Copyright 2019 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.precompile.v1 | ||
|
|
||
| import org.gradle.api.Project | ||
| import org.gradle.api.initialization.Settings | ||
| import org.gradle.api.invocation.Gradle | ||
| import org.gradle.kotlin.dsl.* | ||
| import org.gradle.kotlin.dsl.precompile.PrecompiledScriptDependenciesResolver | ||
| import org.gradle.plugin.use.PluginDependenciesSpec | ||
| import org.gradle.plugin.use.PluginDependencySpec | ||
| import org.jetbrains.kotlin.scripting.definitions.getEnvironment | ||
| import kotlin.script.dependencies.Environment | ||
| import kotlin.script.experimental.annotations.KotlinScript | ||
| import kotlin.script.experimental.api.ScriptCompilationConfiguration | ||
| import kotlin.script.experimental.api.ScriptConfigurationRefinementContext | ||
| import kotlin.script.experimental.api.asSuccess | ||
| import kotlin.script.experimental.api.baseClass | ||
| import kotlin.script.experimental.api.defaultImports | ||
| import kotlin.script.experimental.api.hostConfiguration | ||
| import kotlin.script.experimental.api.implicitReceivers | ||
| import kotlin.script.experimental.api.refineConfiguration | ||
| import kotlin.script.experimental.api.with | ||
| import kotlin.script.experimental.host.ScriptingHostConfiguration | ||
| import kotlin.script.extensions.SamWithReceiverAnnotations | ||
| import kotlin.script.templates.ScriptTemplateDefinition | ||
|
|
||
|
|
||
| /** | ||
| * Script template definition for precompiled Kotlin script targeting [Gradle] instances. | ||
| * | ||
| * @see PrecompiledProjectScript | ||
| */ | ||
| @ScriptTemplateDefinition | ||
| @KotlinScript( | ||
| fileExtension = "init.gradle.kts", | ||
| compilationConfiguration = PrecompiledInitScriptCompilationConfiguration::class | ||
| ) | ||
| @SamWithReceiverAnnotations("org.gradle.api.HasImplicitReceiver") | ||
| @GradleDsl | ||
| open class PrecompiledInitScript(@Suppress("unused_parameter") target: Gradle) | ||
|
|
||
|
|
||
| /** | ||
| * Script template definition for precompiled Kotlin script targeting [Settings] instances. | ||
| * | ||
| * @see PrecompiledProjectScript | ||
| */ | ||
| @ScriptTemplateDefinition | ||
| @KotlinScript( | ||
| fileExtension = "settings.gradle.kts", | ||
| compilationConfiguration = PrecompiledSettingsScriptCompilationConfiguration::class | ||
| ) | ||
| @SamWithReceiverAnnotations("org.gradle.api.HasImplicitReceiver") | ||
| @GradleDsl | ||
| open class PrecompiledSettingsScript(@Suppress("unused_parameter") target: Settings) | ||
|
|
||
|
|
||
| /** | ||
| * Script template definition for precompiled Kotlin scripts targeting [Project] instances. | ||
| * | ||
| * A precompiled script is a script compiled as part of a regular Kotlin source-set and distributed | ||
| * in the usual way, java class files packaged in some library, meant to be consumed as a binary | ||
| * Gradle plugin. | ||
| * | ||
| * The Gradle plugin id by which the precompiled script can be referenced is derived from its name | ||
| * and package declaration - if any - in the following fashion: | ||
| * | ||
| * ```kotlin | ||
| * fun pluginIdFor(script: File, packageName: String?) = | ||
| * (packageName?.let { "$it." } ?: "") + script.nameWithoutExtension | ||
| * ``` | ||
| * | ||
| * Thus, the script `src/main/kotlin/code-quality.gradle.kts` would be exposed as the `code-quality` | ||
| * plugin (assuming it has no package declaration) whereas the script | ||
| * `src/main/kotlin/gradlebuild/code-quality.gradle.kts` would be exposed as the `gradlebuild.code-quality` | ||
| * plugin, again assuming it has the matching package declaration. | ||
| */ | ||
| @ScriptTemplateDefinition | ||
| @KotlinScript( | ||
| fileExtension = "gradle.kts", | ||
| compilationConfiguration = PrecompiledProjectScriptCompilationConfiguration::class | ||
| ) | ||
| @SamWithReceiverAnnotations("org.gradle.api.HasImplicitReceiver") | ||
| @GradleDsl | ||
| open class PrecompiledProjectScript( | ||
| private val target: Project | ||
| ) { | ||
|
|
||
| /** | ||
| * Configures the build script classpath for this project. | ||
| * | ||
| * @see [Project.buildscript] | ||
| */ | ||
| @Suppress("unused") | ||
| open fun buildscript(@Suppress("unused_parameter") block: ScriptHandlerScope.() -> Unit) { | ||
| throw IllegalStateException("The `buildscript` block is not supported on Kotlin script plugins, please use the `plugins` block or project level dependencies.") | ||
| } | ||
|
|
||
| /** | ||
| * Configures the plugin dependencies for this project. | ||
| * | ||
| * @see [PluginDependenciesSpec] | ||
| */ | ||
| @Suppress("unused") | ||
| fun plugins(@Suppress("unused_parameter") block: PluginDependenciesSpec.() -> Unit) { | ||
| block( | ||
| PluginDependenciesSpec { pluginId -> | ||
| target.pluginManager.apply(pluginId) | ||
| NullPluginDependencySpec | ||
| }) | ||
| } | ||
|
|
||
| object NullPluginDependencySpec : PluginDependencySpec { | ||
| override fun apply(apply: Boolean) = this | ||
| override fun version(version: String?) = this | ||
| } | ||
| } | ||
|
|
||
|
|
||
| object PrecompiledInitScriptCompilationConfiguration : ScriptCompilationConfiguration({ | ||
| baseClass(PrecompiledInitScript::class) | ||
| implicitReceivers(Gradle::class) | ||
| setUpDefaultImports() | ||
| }) | ||
|
|
||
|
|
||
| object PrecompiledSettingsScriptCompilationConfiguration : ScriptCompilationConfiguration({ | ||
| baseClass(PrecompiledSettingsScript::class) | ||
| implicitReceivers(Settings::class) | ||
| setUpDefaultImports() | ||
| }) | ||
|
|
||
|
|
||
| object PrecompiledProjectScriptCompilationConfiguration : ScriptCompilationConfiguration({ | ||
| baseClass(PrecompiledProjectScript::class) | ||
| implicitReceivers(Project::class) | ||
| setUpDefaultImports() | ||
| }) | ||
|
|
||
|
|
||
| private | ||
| fun ScriptCompilationConfiguration.Builder.setUpDefaultImports() { | ||
| refineConfiguration { | ||
| beforeCompiling { context -> | ||
| val environment = scriptResolverEnvironmentOf(context) | ||
| require(environment != null) | ||
| context.compilationConfiguration.with { | ||
| defaultImports( | ||
| PrecompiledScriptDependenciesResolver.implicitImportsForScript( | ||
| context.script.text, | ||
| environment | ||
| ) | ||
| ) | ||
| }.asSuccess() | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
||
| private | ||
| fun scriptResolverEnvironmentOf(context: ScriptConfigurationRefinementContext): Environment? = | ||
| context | ||
| .compilationConfiguration[ScriptCompilationConfiguration.hostConfiguration] | ||
| ?.get(ScriptingHostConfiguration.getEnvironment) | ||
| ?.invoke() |
Oops, something went wrong.