Simplify to only 2 plugins

Author: martinbonnin

README.md

@@ -6,7 +6,7 @@ When used in classloader isolation mode, Gratatouille enforces a clear separatio
 
 **Key Features**:
 
-* [Tasks Generation](#functions)
+* [Tasks Generation](#functional-programming-style)
 * [Comprehensive input/output types](#supported-input-and-output-types)
 * [Non overlapping task outputs by default](#non-overlapping-task-outputs-by-default)
 * [Build cache by default](#build-cache-by-default)
@@ -17,7 +17,7 @@ When used in classloader isolation mode, Gratatouille enforces a clear separatio
 * [Classloader isolation](#classloader-isolation-optional) (optional)
 * [kotlinx serialization support](#experimental-kotlinxserialization-support) (experimental)
 
-Check out the [Apollo Faker Gradle Plugin](https://github.com/apollographql/apollo-kotlin-faker/blob/main/gradle-plugin/build.gradle.kts) for a real life example or [test-app](test-app) for integration tests.
+Check out the [Apollo Faker Gradle Plugin](https://github.com/apollographql/apollo-kotlin-faker/blob/main/gradle-plugin/build.gradle.kts) for a real-life example or [test-app](test-app) for integration tests.
 
 Gratatouille also uses Gratatouille to build its plugin, check [gratatouille-gradle-plugin/build.gradle.kts](gratatouille-gradle-plugin/build.gradle.kts) for more details. 
 
@@ -37,9 +37,9 @@ plugins {
 
 gratatouille {
   // Configure the plugin marker
+  // This is only required for publication. 
+  // If you're using GradleUp/Librarian, you can skip this step.
   pluginMarker("com.example.myplugin")
-  // Enable code generation
-  codeGeneration()
 }
 ```
 
@@ -192,7 +192,7 @@ fun myPlugin(project: Project) {
 }
 ```
 
-No need to implement `DefaultTask`, no risk of forgetting `@Cacheable`, etc... Gratatouille provides good defaults making it easier to write plugins.
+No need to implement `DefaultTask`, no risk of forgetting `@Cacheable`, etc... Gratatouille provides good defaults, making it easier to write plugins.
 
 ## Features
 
@@ -352,15 +352,12 @@ dependencies {
     // Add dependencies needed to do your task work
     implementation("com.squareup:kotlinpoet:1.14.2")
     implementation("org.ow2.asm:asm-commons:9.6")
-    // do **not** add gradleApi() here
+    // do **not** add gradle-api here
 }
 
 gratatouille {
-  // Enable code generation
-  codeGeneration {
-    // Enables classloader isolation
-    classLoaderIsolation()
-  }
+  // You may specify additional configuration options here
+  enableKotlinxSerialization.set(true)
 }
 ```
 
@@ -379,7 +376,7 @@ internal fun prepareIngredients(persons: Int, ingredients: GOutputFile) {
 }
 ```
 
-When using this mode, the plugin wiring code is generated as resources that are included by the `gradle-plugin` project. 
+When using this mode, the plugin wiring code is generated as resources that are automatically included by the `gradle-plugin` project. 
 
 ### Step 2/2 gradle-plugin
 
@@ -388,12 +385,12 @@ To use the generated code in your plugin, create an `gradle-plugin` project next
 > [!IMPORTANT]
 > By using two different projects, Gratatouille ensures that Gradle classes do not leak in your plugin implementation and vice-versa.
 
-Apply the `com.gradleup.gratatouille.wiring` plugin in your `gradle-plugin` project:
+Apply the `com.gradleup.gratatouille` plugin in your `gradle-plugin` project:
 
 ```kotlin
 // gradle-plugin/build.gradle.kts
 plugins {
-    id("com.gradleup.gratatouille.wiring").version("0.1.3")
+    id("com.gradleup.gratatouille").version("0.1.3")
 }
 
 gratatouille {

gratatouille-gradle-plugin/api/gratatouille-gradle-plugin.api

@@ -1,98 +1,52 @@
 public abstract interface class gratatouille/gradle/ClassloaderIsolationSpec {
-	public abstract fun getConfigurationName ()Lorg/gradle/api/provider/Property;
-	public abstract fun getCoordinates ()Lorg/gradle/api/provider/Property;
 }
 
-public abstract interface class gratatouille/gradle/CodeGenerationSpec {
-	public abstract fun classLoaderIsolation ()V
-	public abstract fun classLoaderIsolation (Lorg/gradle/api/Action;)V
-	public abstract fun getAddDependencies ()Lorg/gradle/api/provider/Property;
+public abstract interface class gratatouille/gradle/CodeGenerationExtension {
+	public abstract fun getAddDependencies ()Z
 	public abstract fun getEnableKotlinxSerialization ()Lorg/gradle/api/provider/Property;
+	public abstract fun setAddDependencies (Z)V
 }
 
-public abstract interface class gratatouille/gradle/CodeGeneratorExtension {
-	public abstract fun codeGeneration ()V
-	public abstract fun codeGeneration (Lorg/gradle/api/Action;)V
+public abstract interface class gratatouille/gradle/GratatouilleExtension : gratatouille/gradle/CodeGenerationExtension {
+	public abstract fun pluginDescriptor (Ljava/lang/String;Ljava/lang/String;)V
+	public abstract fun pluginLocalPublication (Ljava/lang/String;)V
+	public abstract fun pluginMarker (Ljava/lang/String;)V
+	public abstract fun pluginMarker (Ljava/lang/String;Ljava/lang/String;)V
 }
 
-public abstract class gratatouille/gradle/DefaultGratatouilleExtension : gratatouille/gradle/GratatouilleExtension {
-	public fun <init> (Lorg/gradle/api/Project;)V
-	public fun codeGeneration ()V
-	public fun codeGeneration (Lorg/gradle/api/Action;)V
-	public fun pluginDescriptor (Ljava/lang/String;Ljava/lang/String;)V
-	public fun pluginLocalPublication (Ljava/lang/String;)V
-	public fun pluginMarker (Ljava/lang/String;)V
-	public fun pluginMarker (Ljava/lang/String;Ljava/lang/String;)V
+public abstract interface class gratatouille/gradle/GratatouilleTasksExtension : gratatouille/gradle/CodeGenerationExtension {
+	public abstract fun getConfigurationName ()Lorg/gradle/api/provider/Property;
+	public abstract fun getCoordinates ()Lorg/gradle/api/provider/Property;
 }
 
-public abstract class gratatouille/gradle/DefaultGratatouilleTasksExtension : gratatouille/gradle/GratatouilleTasksExtension {
-	public fun <init> (Lorg/gradle/api/Project;)V
-	public fun codeGeneration ()V
-	public fun codeGeneration (Lorg/gradle/api/Action;)V
+public final class gratatouille/gradle/VersionKt {
+	public static final field VERSION Ljava/lang/String;
 }
 
-public abstract class gratatouille/gradle/DefaultGratatouilleWiringExtension : gratatouille/gradle/GratatouilleWiringExtension {
+public abstract class gratatouille/gradle/internal/DefaultGratatouilleExtension : gratatouille/gradle/GratatouilleExtension {
 	public fun <init> (Lorg/gradle/api/Project;)V
-	public fun codeGeneration ()V
-	public fun codeGeneration (Lorg/gradle/api/Action;)V
 	public fun pluginDescriptor (Ljava/lang/String;Ljava/lang/String;)V
 	public fun pluginLocalPublication (Ljava/lang/String;)V
 	public fun pluginMarker (Ljava/lang/String;)V
 	public fun pluginMarker (Ljava/lang/String;Ljava/lang/String;)V
 }
 
-public final class gratatouille/gradle/ExtensionsKt {
-	public static final fun plugin (Lorg/gradle/api/Project;)V
-	public static final fun tasksPlugin (Lorg/gradle/api/Project;)V
-	public static final fun wiringPlugin (Lorg/gradle/api/Project;)V
-}
-
-public abstract interface class gratatouille/gradle/GratatouilleExtension : gratatouille/gradle/CodeGeneratorExtension, gratatouille/gradle/WiringExtension {
-}
-
-public abstract interface class gratatouille/gradle/GratatouilleTasksExtension : gratatouille/gradle/CodeGeneratorExtension {
-}
-
-public abstract interface class gratatouille/gradle/GratatouilleWiringExtension : gratatouille/gradle/CodeGeneratorExtension, gratatouille/gradle/WiringExtension {
-}
-
-public abstract class gratatouille/gradle/Plugin : org/gradle/api/Plugin {
-	public fun <init> ()V
-	public synthetic fun apply (Ljava/lang/Object;)V
-	public fun apply (Lorg/gradle/api/Project;)V
-}
-
-public abstract class gratatouille/gradle/TasksPlugin : org/gradle/api/Plugin {
+public abstract class gratatouille/gradle/internal/DefaultGratatouilleExtensionPlugin : org/gradle/api/Plugin {
 	public fun <init> ()V
 	public synthetic fun apply (Ljava/lang/Object;)V
 	public fun apply (Lorg/gradle/api/Project;)V
 }
 
-public final class gratatouille/gradle/VersionKt {
-	public static final field VERSION Ljava/lang/String;
-}
-
-public abstract interface class gratatouille/gradle/WiringExtension {
-	public abstract fun pluginDescriptor (Ljava/lang/String;Ljava/lang/String;)V
-	public abstract fun pluginLocalPublication (Ljava/lang/String;)V
-	public abstract fun pluginMarker (Ljava/lang/String;)V
-	public abstract fun pluginMarker (Ljava/lang/String;Ljava/lang/String;)V
+public abstract class gratatouille/gradle/internal/DefaultGratatouilleTasksExtension : gratatouille/gradle/GratatouilleTasksExtension {
+	public fun <init> (Lorg/gradle/api/Project;)V
 }
 
-public abstract class gratatouille/gradle/WiringPlugin : org/gradle/api/Plugin {
+public abstract class gratatouille/gradle/internal/DefaultGratatouilleTasksExtensionPlugin : org/gradle/api/Plugin {
 	public fun <init> ()V
 	public synthetic fun apply (Ljava/lang/Object;)V
 	public fun apply (Lorg/gradle/api/Project;)V
 }
 
-public final class gratatouille/gradle/internal/DefaultCodeGenerationSpec : gratatouille/gradle/CodeGenerationSpec {
-	public fun <init> (Lorg/gradle/api/Project;)V
-	public fun classLoaderIsolation ()V
-	public fun classLoaderIsolation (Lorg/gradle/api/Action;)V
-	public fun getAddDependencies ()Lorg/gradle/api/provider/Property;
-	public fun getEnableKotlinxSerialization ()Lorg/gradle/api/provider/Property;
-}
-
 public final class gratatouille/gradle/tasks/GenerateDescriptorEntryPoint {
 	public static final field Companion Lgratatouille/gradle/tasks/GenerateDescriptorEntryPoint$Companion;
 	public fun <init> ()V

gratatouille-gradle-plugin/src/main/kotlin/gratatouille/gradle/ClassloaderIsolationSpec.kt

@@ -3,18 +3,6 @@ package gratatouille.gradle
 import org.gradle.api.provider.Property
 
 interface ClassloaderIsolationSpec {
-  /**
-   * The coordinates of the artifact where the task implementations are in the form group:artifact:version.
-   *
-   * Default: project.group:project.name:project.version
-   */
-  val coordinates: Property<String>
 
-  /**
-   * Unique name to identify the configuration
-   *
-   * Defaults to a name based on [coordinates]
-   */
-  val configurationName: Property<String>
 
 }

gratatouille-gradle-plugin/src/main/kotlin/gratatouille/gradle/CodeGenerationExtension.kt

@@ -0,0 +1,17 @@
+package gratatouille.gradle
+
+import org.gradle.api.provider.Property
+
+interface CodeGenerationExtension {
+  /**
+   * Enables experimental support for kotlinx serialization when generating tasks.
+   */
+  val enableKotlinxSerialization: Property<Boolean>
+
+  /**
+   * Automatically add dependencies needed for code generation if KSP is present.
+   *
+   * Default: true
+   */
+  var addDependencies: Boolean
+}

gratatouille-gradle-plugin/src/main/kotlin/gratatouille/gradle/CodeGenerationSpec.kt

@@ -0,0 +1,47 @@
+package gratatouille.gradle
+
+import gratatouille.wiring.GPlugin
+import gratatouille.gradle.internal.*
+import gratatouille.gradle.tasks.registerUnzipFilesTask
+import org.gradle.api.Action
+import org.gradle.api.Project
+import org.gradle.api.attributes.Usage
+
+interface GratatouilleExtension: CodeGenerationExtension {
+  /**
+   * Registers a `generate${pluginId}Descriptor` task that generates a [plugin descriptor](https://docs.gradle.org/current/userguide/java_gradle_plugin.html#sec:gradle_plugin_dev_usage) for the plugin
+   * and wires it to the `processResources` task.
+   *
+   * The descriptor will be included in the .jar file making it possible to locate the plugin implementation from the plugin id.
+   *
+   * Calling this function is usually not needed if using code generation as code generation can use `@GPlugin` to get the plugin id.
+   *
+   * @param implementationClass the fully qualified class name for the plugin implementation. Example: `com.example.ExamplePlugin`.
+   */
+  fun pluginDescriptor(id: String, implementationClass: String)
+
+  /**
+   * Creates a new `${pluginId}PluginMarkerMaven` publication allowing to locate the implementation coordinates from the plugin id.
+   * This method requires that only a single publication is present in this project. See other overloads if you need more control over publications.
+   *
+   * @throws IllegalStateException if there are more
+   */
+  fun pluginMarker(id: String)
+
+  /**
+   * Creates a new `${pluginId}PluginMarkerMaven` publication allowing to locate the implementation coordinates from the plugin id.
+   *
+   * @param mainPublication the publication to redirect to.
+   */
+  fun pluginMarker(id: String, mainPublication: String)
+
+  /**
+   * Registers a local plugin publication so that the plugin is discoverable from included builds.
+   *
+   * This function uses Gradle internal APIs.
+   *
+   * @param id the plugin id
+   */
+  fun pluginLocalPublication(id: String)
+}
+

gratatouille-gradle-plugin/src/main/kotlin/gratatouille/gradle/GratatouilleExtension.kt

@@ -0,0 +1,19 @@
+package gratatouille.gradle
+
+import org.gradle.api.provider.Property
+
+interface GratatouilleTasksExtension: CodeGenerationExtension {
+  /**
+   * The coordinates of the artifact where the task implementations are in the form group:artifact:version.
+   *
+   * Default: project.group:project.name:project.version
+   */
+  val coordinates: Property<String>
+
+  /**
+   * Unique name to identify the configuration
+   *
+   * Defaults to a name based on [coordinates]
+   */
+  val configurationName: Property<String>
+}