Cocoon compiler plugin skeleton.

ychescale9 · ychescale9 · commit 60d8f2415924 · 2025-05-10T13:04:58.000+10:00
diff --git a/build-logic/cocoon/cocoon-compiler-plugin/build.gradle.kts b/build-logic/cocoon/cocoon-compiler-plugin/build.gradle.kts
@@ -0,0 +1,54 @@
+import io.gitlab.arturbosch.detekt.Detekt
+import org.gradle.kotlin.dsl.withType
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    alias(libs.plugins.kotlin.jvm)
+    alias(libs.plugins.detekt)
+}
+
+group = "io.github.reactivecircus.cocoon"
+version = "0.1.0"
+
+kotlin {
+    explicitApi()
+}
+
+tasks.withType<KotlinCompile>().configureEach {
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_11)
+        optIn.add("org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi")
+    }
+}
+
+tasks.withType<JavaCompile>().configureEach {
+    sourceCompatibility = JavaVersion.VERSION_11.toString()
+    targetCompatibility = JavaVersion.VERSION_11.toString()
+}
+
+detekt {
+    source.from(files("src/"))
+    config.from(files("$rootDir/../detekt.yml"))
+    buildUponDefaultConfig = true
+    allRules = true
+    parallel = true
+}
+
+tasks.withType<Detekt>().configureEach {
+    jvmTarget = JvmTarget.JVM_11.target
+    reports {
+        xml.required.set(false)
+        txt.required.set(false)
+        sarif.required.set(false)
+        md.required.set(false)
+    }
+}
+
+dependencies {
+    // enable Ktlint formatting
+    add("detektPlugins", libs.plugin.detektFormatting)
+
+    compileOnly(libs.kotlin.compiler)
+    compileOnly(libs.kotlin.stblib)
+}
diff --git a/build-logic/cocoon/cocoon-compiler-plugin/gradle.properties b/build-logic/cocoon/cocoon-compiler-plugin/gradle.properties
@@ -0,0 +1 @@
+kotlin.stdlib.default.dependency=false
diff --git a/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/CocoonCommandLineProcessor.kt b/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/CocoonCommandLineProcessor.kt
@@ -0,0 +1,39 @@
+package io.github.reactivecircus.cocoon.compiler
+
+import org.jetbrains.kotlin.compiler.plugin.AbstractCliOption
+import org.jetbrains.kotlin.compiler.plugin.CliOption
+import org.jetbrains.kotlin.compiler.plugin.CommandLineProcessor
+import org.jetbrains.kotlin.config.CompilerConfiguration
+import org.jetbrains.kotlin.config.CompilerConfigurationKey
+
+public class CocoonCommandLineProcessor : CommandLineProcessor {
+
+    override val pluginId: String = "io.github.reactivecircus.cocoon.compiler"
+
+    @Suppress("MaxLineLength")
+    override val pluginOptions: Collection<AbstractCliOption> = listOf(
+        CliOption(
+            optionName = CompilerOptions.Annotation.toString(),
+            valueDescription = "Fully qualified annotation class name",
+            description = "The fully qualified name of the annotation to be used for marking functions for transformation.",
+        ),
+        CliOption(
+            optionName = CompilerOptions.WrappingFunction.toString(),
+            valueDescription = "Fully qualified name of the higher-order function to be used for wrapping the transformed function's body.",
+            description = "The fully qualified name of the function to be used for wrapping the transformed function.",
+        ),
+    )
+
+    override fun processOption(option: AbstractCliOption, value: String, configuration: CompilerConfiguration) {
+        when (option.optionName) {
+            CompilerOptions.Annotation.toString() -> configuration.put(CompilerOptions.Annotation, value)
+            CompilerOptions.WrappingFunction.toString() -> configuration.put(CompilerOptions.WrappingFunction, value)
+            else -> throw IllegalArgumentException("Unknown plugin option: ${option.optionName}")
+        }
+    }
+
+    internal object CompilerOptions {
+        val Annotation = CompilerConfigurationKey<String>("annotation")
+        val WrappingFunction = CompilerConfigurationKey<String>("wrappingFunction")
+    }
+}
diff --git a/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/CocoonCompilerPluginRegistrar.kt b/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/CocoonCompilerPluginRegistrar.kt
@@ -0,0 +1,37 @@
+package io.github.reactivecircus.cocoon.compiler
+
+import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension
+import org.jetbrains.kotlin.cli.common.messages.MessageCollector
+import org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar
+import org.jetbrains.kotlin.config.CommonConfigurationKeys
+import org.jetbrains.kotlin.config.CompilerConfiguration
+
+public class CocoonCompilerPluginRegistrar : CompilerPluginRegistrar() {
+
+    override val supportsK2: Boolean = true
+
+    override fun ExtensionStorage.registerExtensions(configuration: CompilerConfiguration) {
+        val annotationString = requireNotNull(
+            configuration.get(CocoonCommandLineProcessor.CompilerOptions.Annotation)
+        )
+        val annotationClassId = annotationString.toClassId()
+
+        val wrappingFunctionString = requireNotNull(
+            configuration.get(CocoonCommandLineProcessor.CompilerOptions.WrappingFunction)
+        )
+        val wrappingFunctionCallableId = wrappingFunctionString.toCallableId()
+
+        val messageCollector = configuration.get(
+            CommonConfigurationKeys.MESSAGE_COLLECTOR_KEY,
+            MessageCollector.NONE
+        )
+
+        IrGenerationExtension.registerExtension(
+            extension = CocoonIrGenerationExtension(
+                annotationName = annotationClassId,
+                wrappingFunctionName = wrappingFunctionCallableId,
+                messageCollector = messageCollector,
+            )
+        )
+    }
+}
diff --git a/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/CocoonFunctionTransformer.kt b/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/CocoonFunctionTransformer.kt
@@ -0,0 +1,16 @@
+package io.github.reactivecircus.cocoon.compiler
+
+import org.jetbrains.kotlin.backend.common.IrElementTransformerVoidWithContext
+import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext
+import org.jetbrains.kotlin.cli.common.messages.MessageCollector
+import org.jetbrains.kotlin.name.CallableId
+import org.jetbrains.kotlin.name.ClassId
+
+internal class CocoonFunctionTransformer(
+    private val pluginContext: IrPluginContext,
+    private val messageCollector: MessageCollector,
+    private val annotationName: ClassId,
+    private val wrappingFunctionName: CallableId,
+) : IrElementTransformerVoidWithContext() {
+
+}
diff --git a/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/CocoonIrGenerationExtension.kt b/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/CocoonIrGenerationExtension.kt
@@ -0,0 +1,35 @@
+package io.github.reactivecircus.cocoon.compiler
+
+import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension
+import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext
+import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity
+import org.jetbrains.kotlin.cli.common.messages.MessageCollector
+import org.jetbrains.kotlin.ir.declarations.IrModuleFragment
+import org.jetbrains.kotlin.ir.symbols.UnsafeDuringIrConstructionAPI
+import org.jetbrains.kotlin.name.CallableId
+import org.jetbrains.kotlin.name.ClassId
+
+internal class CocoonIrGenerationExtension(
+    private val annotationName: ClassId,
+    private val wrappingFunctionName: CallableId,
+    private val messageCollector: MessageCollector,
+) : IrGenerationExtension {
+    @OptIn(UnsafeDuringIrConstructionAPI::class)
+    override fun generate(moduleFragment: IrModuleFragment, pluginContext: IrPluginContext) {
+        if (pluginContext.referenceClass(annotationName) == null) {
+            messageCollector.report(CompilerMessageSeverity.ERROR, "Could not find annotation class <$annotationName>.")
+            return
+        }
+        if (pluginContext.referenceFunctions(wrappingFunctionName).isEmpty()) {
+            messageCollector.report(
+                CompilerMessageSeverity.ERROR,
+                "Could not find wrapping function <$wrappingFunctionName>.",
+            )
+            return
+        }
+        moduleFragment.transform(
+            CocoonFunctionTransformer(pluginContext, messageCollector, annotationName, wrappingFunctionName),
+            null,
+        )
+    }
+}
diff --git a/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/utils.kt b/build-logic/cocoon/cocoon-compiler-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/compiler/utils.kt
@@ -0,0 +1,11 @@
+package io.github.reactivecircus.cocoon.compiler
+
+import org.jetbrains.kotlin.name.CallableId
+import org.jetbrains.kotlin.name.ClassId
+import org.jetbrains.kotlin.name.FqName
+
+internal fun String.toClassId(): ClassId =
+    FqName(this).run { ClassId(parent(), shortName()) }
+
+internal fun String.toCallableId(): CallableId =
+    FqName(this).run { CallableId(parent(), shortName()) }
diff --git a/build-logic/cocoon/cocoon-compiler-plugin/src/main/resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.CommandLineProcessor b/build-logic/cocoon/cocoon-compiler-plugin/src/main/resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.CommandLineProcessor
@@ -0,0 +1 @@
+io.github.reactivecircus.cocoon.compiler.CocoonCommandLineProcessor
diff --git a/build-logic/cocoon/cocoon-compiler-plugin/src/main/resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar b/build-logic/cocoon/cocoon-compiler-plugin/src/main/resources/META-INF/services/org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar
@@ -0,0 +1 @@
+io.github.reactivecircus.cocoon.compiler.CocoonCompilerPluginRegistrar
diff --git a/build-logic/cocoon/cocoon-gradle-plugin/build.gradle.kts b/build-logic/cocoon/cocoon-gradle-plugin/build.gradle.kts
@@ -0,0 +1,58 @@
+import io.gitlab.arturbosch.detekt.Detekt
+import org.gradle.kotlin.dsl.withType
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    `kotlin-dsl`
+    alias(libs.plugins.detekt)
+}
+
+gradlePlugin {
+    plugins {
+        register("cocoon") {
+            id = "io.github.reactivecircus.cocoon"
+            implementationClass = "io.github.reactivecircus.cocoon.gradle.CocoonPlugin"
+        }
+    }
+}
+
+kotlin {
+    explicitApi()
+}
+
+tasks.withType<KotlinCompile>().configureEach {
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_11)
+    }
+}
+
+tasks.withType<JavaCompile>().configureEach {
+    sourceCompatibility = JavaVersion.VERSION_11.toString()
+    targetCompatibility = JavaVersion.VERSION_11.toString()
+}
+
+detekt {
+    source.from(files("src/"))
+    config.from(files("$rootDir/../detekt.yml"))
+    buildUponDefaultConfig = true
+    allRules = true
+    parallel = true
+}
+
+tasks.withType<Detekt>().configureEach {
+    jvmTarget = JvmTarget.JVM_11.target
+    reports {
+        xml.required.set(false)
+        txt.required.set(false)
+        sarif.required.set(false)
+        md.required.set(false)
+    }
+}
+
+dependencies {
+    // enable Ktlint formatting
+    add("detektPlugins", libs.plugin.detektFormatting)
+
+    compileOnly(libs.plugin.kotlin)
+}
diff --git a/build-logic/cocoon/cocoon-gradle-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/gradle/CocoonExtension.kt b/build-logic/cocoon/cocoon-gradle-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/gradle/CocoonExtension.kt
@@ -0,0 +1,10 @@
+package io.github.reactivecircus.cocoon.gradle
+
+import org.gradle.api.model.ObjectFactory
+import org.gradle.api.provider.Property
+import org.gradle.kotlin.dsl.property
+
+public abstract class CocoonExtension internal constructor(objects: ObjectFactory) {
+    public val annotation: Property<String> = objects.property<String>()
+    public val wrappingFunction: Property<String> = objects.property<String>()
+}
diff --git a/build-logic/cocoon/cocoon-gradle-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/gradle/CocoonPlugin.kt b/build-logic/cocoon/cocoon-gradle-plugin/src/main/kotlin/io/github/reactivecircus/cocoon/gradle/CocoonPlugin.kt
@@ -0,0 +1,45 @@
+package io.github.reactivecircus.cocoon.gradle
+
+import org.gradle.api.Project
+import org.gradle.api.provider.Provider
+import org.gradle.kotlin.dsl.getByType
+import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation
+import org.jetbrains.kotlin.gradle.plugin.KotlinCompilerPluginSupportPlugin
+import org.jetbrains.kotlin.gradle.plugin.SubpluginArtifact
+import org.jetbrains.kotlin.gradle.plugin.SubpluginOption
+
+public class CocoonPlugin : KotlinCompilerPluginSupportPlugin {
+
+    override fun apply(target: Project) {
+        target.extensions.create("cocoon", CocoonExtension::class.java)
+    }
+
+    override fun applyToCompilation(kotlinCompilation: KotlinCompilation<*>): Provider<List<SubpluginOption>> {
+        val project = kotlinCompilation.target.project
+        val extension = project.extensions.getByType<CocoonExtension>()
+        return project.provider {
+            listOf(
+                SubpluginOption(
+                    key = "annotation",
+                    value = extension.annotation.get(),
+                ),
+                SubpluginOption(
+                    key = "wrappingFunction",
+                    value = extension.wrappingFunction.get(),
+                ),
+            )
+        }
+    }
+
+    override fun getCompilerPluginId(): String = "io.github.reactivecircus.cocoon.compiler"
+
+    override fun getPluginArtifact(): SubpluginArtifact {
+        return SubpluginArtifact(
+            groupId = "io.github.reactivecircus.cocoon",
+            artifactId = "cocoon-compiler-plugin",
+            version = "0.1.0",
+        )
+    }
+
+    override fun isApplicable(kotlinCompilation: KotlinCompilation<*>): Boolean = true
+}
diff --git a/build-logic/settings.gradle.kts b/build-logic/settings.gradle.kts
@@ -46,3 +46,5 @@ plugins {
 
 rootProject.name = "build-logic"
 include(":kstreamlined-gradle-plugin")
+include(":cocoon:cocoon-compiler-plugin")
+include(":cocoon:cocoon-gradle-plugin")
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -84,6 +84,8 @@ plugin-playPublisher = { module = "com.github.triplet.gradle:play-publisher", ve
 plugin-skie = { module = "co.touchlab.skie:co.touchlab.skie.gradle.plugin", version.ref = "skie"}
 plugin-sqldelight = { module = "app.cash.sqldelight:app.cash.sqldelight.gradle.plugin", version.ref = "sqldelight"}
 plugin-baselineprofile = { module = "androidx.baselineprofile:androidx.baselineprofile.gradle.plugin", version.ref = "androidx-benchmark"}
+kotlin-compiler = { module = "org.jetbrains.kotlin:kotlin-compiler", version.ref = "kotlin"}
+kotlin-stblib = { module = "org.jetbrains.kotlin:kotlin-stdlib", version.ref = "kotlin"}
 leakcanary-android = { module = "com.squareup.leakcanary:leakcanary-android", version.ref = "leakcanary" }
 leakcanary-plumber = { module = "com.squareup.leakcanary:plumber-android", version.ref = "leakcanary" }
 hilt-android = { module = "com.google.dagger:hilt-android", version.ref = "hilt" }
@@ -145,4 +147,5 @@ kermit = { module = "co.touchlab:kermit", version.ref = "kermit" }
 crashKios = { module = "co.touchlab:crashkios", version.ref = "crashKios" }
 
 [plugins]
+kotlin-jvm = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
 detekt = { id = "io.gitlab.arturbosch.detekt", version.ref = "detekt" }
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -1,7 +1,6 @@
 import com.android.build.api.dsl.SettingsExtension
 
 pluginManagement {
-    includeBuild("build-logic")
     repositories {
         google {
             content {
@@ -33,6 +32,8 @@ pluginManagement {
     }
 }
 
+includeBuild("build-logic")
+
 dependencyResolutionManagement {
     @Suppress("UnstableApiUsage")
     repositories {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+io.github.reactivecircus.cocoon.compiler.CocoonCommandLineProcessor`