Rework ExampleSubplugin for the new subplugins API

This commit is contained in:
Sergey Igushkin
2020-06-06 00:29:12 +03:00
parent a2e4b52747
commit 66a59df7de
7 changed files with 76 additions and 17 deletions
@@ -29,20 +29,23 @@ import com.intellij.mock.MockProject
public object ExampleConfigurationKeys {
public val EXAMPLE_KEY: CompilerConfigurationKey<String> = CompilerConfigurationKey.create<String>("example argument")
public val EXAMPLE_LEGACY_KEY: CompilerConfigurationKey<String> = CompilerConfigurationKey.create<String>("example legacy argument")
}
public class ExampleCommandLineProcessor : CommandLineProcessor {
companion object {
public val EXAMPLE_PLUGIN_ID: String = "example.plugin"
public val EXAMPLE_OPTION: CliOption = CliOption("exampleKey", "<value>", "")
public val EXAMPLE_LEGACY_OPTION: CliOption = CliOption("exampleLegacyKey", "<value>", "")
}
override val pluginId: String = EXAMPLE_PLUGIN_ID
override val pluginOptions: Collection<CliOption> = listOf(EXAMPLE_OPTION)
override val pluginOptions: Collection<CliOption> = listOf(EXAMPLE_OPTION, EXAMPLE_LEGACY_OPTION)
override fun processOption(option: CliOption, value: String, configuration: CompilerConfiguration) {
when (option) {
EXAMPLE_OPTION -> configuration.put(ExampleConfigurationKeys.EXAMPLE_KEY, value)
EXAMPLE_LEGACY_OPTION -> configuration.put(ExampleConfigurationKeys.EXAMPLE_LEGACY_KEY, value)
else -> throw CliOptionProcessingException("Unknown option: ${option.name}")
}
}
@@ -51,7 +54,9 @@ public class ExampleCommandLineProcessor : CommandLineProcessor {
public class ExampleComponentRegistrar : ComponentRegistrar {
public override fun registerProjectComponents(project: MockProject, configuration: CompilerConfiguration) {
val exampleValue = configuration.get(ExampleConfigurationKeys.EXAMPLE_KEY)
val exampleLegacyValue = configuration.get(ExampleConfigurationKeys.EXAMPLE_LEGACY_KEY)
val messageCollector = configuration.get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, MessageCollector.NONE)
messageCollector.report(CompilerMessageSeverity.INFO, "Project component registration: $exampleValue")
messageCollector.report(CompilerMessageSeverity.INFO, "Project component registration: $exampleLegacyValue")
}
}
@@ -0,0 +1,49 @@
/*
* Copyright 2010-2015 JetBrains s.r.o.
*
* 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 example
import org.gradle.api.Project
import org.gradle.api.tasks.compile.AbstractCompile
import org.jetbrains.kotlin.gradle.plugin.*
class ExampleLegacySubplugin : KotlinGradleSubplugin<AbstractCompile> {
override fun isApplicable(project: Project, task: AbstractCompile): Boolean {
return true
}
override fun apply(
project: Project,
kotlinCompile: AbstractCompile,
javaCompile: AbstractCompile?,
variantData: Any?,
androidProjectHandler: Any?,
kotlinCompilation: KotlinCompilation<*>?
): List<SubpluginOption> {
println("ExampleLegacySubplugin loaded")
return listOf(
SubpluginOption("exampleLegacyKey", "exampleLegacyValue")
)
}
override fun getCompilerPluginId(): String {
return "example.plugin"
}
override fun getPluginArtifact(): SubpluginArtifact =
JetBrainsSubpluginArtifact("kotlin-gradle-subplugin-example")
}
@@ -16,26 +16,20 @@
package example
import org.gradle.api.Project
import org.gradle.api.tasks.compile.AbstractCompile
import org.gradle.api.provider.Provider
import org.jetbrains.kotlin.gradle.plugin.*
class ExampleSubplugin : KotlinGradleSubplugin<AbstractCompile> {
class ExampleSubplugin : KotlinCompilerPluginSupportPlugin {
override fun isApplicable(project: Project, task: AbstractCompile): Boolean {
return true
}
override fun isApplicable(kotlinCompilation: KotlinCompilation<*>): Boolean = true
override fun apply(
project: Project,
kotlinCompile: AbstractCompile,
javaCompile: AbstractCompile?,
variantData: Any?,
androidProjectHandler: Any?,
kotlinCompilation: KotlinCompilation<*>?
): List<SubpluginOption> {
override fun applyToCompilation(
kotlinCompilation: KotlinCompilation<*>
): Provider<List<SubpluginOption>> {
println("ExampleSubplugin loaded")
return listOf(SubpluginOption("exampleKey", "exampleValue"))
return kotlinCompilation.target.project.provider {
listOf(SubpluginOption("exampleKey", "exampleValue"))
}
}
override fun getCompilerPluginId(): String {
@@ -0,0 +1 @@
implementation-class=example.ExampleSubplugin
@@ -1 +1,6 @@
example.ExampleSubplugin
#
# Copyright 2010-2020 JetBrains s.r.o. and Kotlin Programming Language contributors.
# Use of this source code is governed by the Apache 2.0 license that can be found in the license/LICENSE.txt file.
#
example.ExampleLegacySubplugin
@@ -21,14 +21,18 @@ class SubpluginsIT : BaseGradleIT() {
project.build("compileKotlin", "build") {
assertSuccessful()
assertContains("ExampleSubplugin loaded")
assertContains("ExampleLegacySubplugin loaded")
assertContains("Project component registration: exampleValue")
assertContains("Project component registration: exampleLegacyValue")
assertTasksExecuted(":compileKotlin")
}
project.build("compileKotlin", "build") {
assertSuccessful()
assertContains("ExampleSubplugin loaded")
assertContains("ExampleLegacySubplugin loaded")
assertNotContains("Project component registration: exampleValue")
assertNotContains("Project component registration: exampleLegacyValue")
assertTasksUpToDate(":compileKotlin")
}
}
@@ -10,6 +10,7 @@ buildscript {
}
apply plugin: "kotlin"
apply plugin: "kotlin-example-subplugin"
repositories {
mavenLocal()