Add AndroidApplicationStorytaleGradlePlugin by congvc-dev · Pull Request #76 · Kotlin/Storytale

congvc-dev · 2025-05-16T15:53:55Z

this PR fixes long awaited #38.
I tested with my local android app module but didn't commit because it isn't necessarily.

JSMonk · 2025-05-18T05:25:47Z

By the way, @congvc-dev, I haven't found your contacts, so I will put them here.
We've added you to the core contributors (because you've made so many fantastic contributions to this project).
We have a call with all the core contributors once a month, so if you would like to join, please send me your contact information in the DM of our Kotlin community Slack.
Thank you a lot for all these magical contributions you introduced 🧙

congvc-dev · 2025-05-18T15:40:48Z

I think im at my limit of knowledge here. Somehow my android app module doesn't register stories sourceset as a build type. Here is my code setup. Someone please help out 🙏

rin0chan · 2025-05-20T09:05:46Z

Hi @congvc-dev 👋, Thank you for your contribution to this issue! I also tried to do some research

for android projects, it seems that you can't directly add a custom sourceSet. Instead, you need to create a flavor to set the corresponding sourceSets (I'm not sure if this is the correct approach).

but i'm currently not sure how to configure the existing Gradle plugin task for the corresponding flavor.

Storytale/modules/gradle-plugin/src/main/kotlin/org/jetbrains/compose/storytale/plugin/AndroidMultiplatformTask.kt

Lines 56 to 68 in 5b22a9a

    
           applicationExtension.applicationVariants 
        
               .matching { it.name == StorytaleGradlePlugin.STORYTALE_EXEC_SUFFIX } 
        
               .configureEach { 
        
                   val generatorTask = createAndroidStorytaleGenerateSourceTask( 
        
                       target, 
        
                       this, 
        
                       storytaleBuildSourcesDir, 
        
                       storytaleBuildResourcesDir, 
        
                   ) 
        
                   extension.project.tasks 
        
                       .matching { it.name == "process${StorytaleGradlePlugin.STORYTALE_EXEC_SUFFIX}MainManifest" } 
        
                       .configureEach { dependsOn(generatorTask) }

Also, I think we might need to do some handling in AndroidMultiplatformTask.kt to configure different dependencies based on KMP or a standalone Android project.

Storytale/modules/gradle-plugin/src/main/kotlin/org/jetbrains/compose/storytale/plugin/AndroidMultiplatformTask.kt

Lines 70 to 76 in 5b22a9a

    
           target.compilations 
        
               .matching { it.name == StorytaleGradlePlugin.STORYTALE_EXEC_SUFFIX } 
        
               .configureEach { 
        
                   associateWith(target.compilations.getByName("debug")) 
        
                   compileTaskProvider.configure { 
        
                       dependsOn(generatorTask) 
        
                       dependsOn(":generateResourceAccessorsForCommonStories")

For example, the task :generateResourceAccessorsForCommonStories doesn't seem like it should be used in non-multiplatform projects.

congvc-dev · 2025-05-20T16:47:28Z

@whitescent, good approach! Thanks for untying the knot for me. I'll try look into it later this weekend

congvc-dev · 2025-05-20T16:49:04Z

@JSMonk, can you shoot me a DM? here is my profile in kotlinlang slack

JSMonk · 2025-05-25T16:36:02Z

 class StorytaleGradlePlugin : KotlinCompilerPluginSupportPlugin {

    override fun apply(project: Project) {
-        project.plugins.withId("org.jetbrains.kotlin.multiplatform") {


@eymar, Am I right that withId works lazily, so that the order of the plugins application doesn't matter if we use withId?

according to the documentation:

* Executes or registers an action for a plugin with given id. * If the plugin was already applied, the action is executed. * If the plugin is applied sometime later the action will be executed after the plugin is applied. * If the plugin is never applied, the action is never executed.

so yes, the order of apply(plugin) calls doesn't matter when using withId.

the new implementation I see on the right side would require a strict order of plugins: Storytale would need to be registered after all other plugins - it's error prone. Ideally the order shouldn't matter.

Using nested withId is a solution which come to my mind. And btw I see it used to be here below.

So, yep, this is what I'm afraid of. @congvc-dev, could you rework it using the withId approach?

So, yep, this is what I'm afraid of. @congvc-dev, could you rework it using the withId approach?

@JSMonk sure, I'm on it rn

JSMonk · 2025-05-25T16:36:33Z

    override fun applyToCompilation(kotlinCompilation: KotlinCompilation<*>) = kotlinCompilation.target.project.provider { emptyList<SubpluginOption>() }

    private fun Project.processConfigurations(extension: StorytaleExtension) {
-        extension.targets.all {


@eymar Does all also work lazily?

Executes the given action against all objects in this collection, and any objects subsequently added to this collection.

So yes, all {} will be invoked on all targets added before and after.

forEach will just iterate on the current state of the collection.

The same here. @congvc-dev could you use all instead of the forEach?

@JSMonk sure thing

eymar · 2025-05-26T14:17:31Z

+        val composeEnabled = project.plugins.hasPlugin("org.jetbrains.compose")
+        val composePluginEnabled = project.plugins.hasPlugin("org.jetbrains.kotlin.plugin.compose")
+        if (
+            (composeEnabled || composePluginEnabled) &&


Storytale strictly requires org.jetbrains.compose rather than org.jetbrains.kotlin.plugin.compose. So || is rather incorrect.

Did you want to make the new plugin to work on android without Compose Multiplatform?

eymar · 2025-05-26T14:20:57Z

    private fun Project.processConfigurations(extension: StorytaleExtension) {
-        extension.targets.all {
-            when (this) {
+        extension.targets.forEach {


why was all replaced by forEach?

Add AndroidApplicationStorytaleGradlePlugin

8717d80

congvc-dev requested a review from JSMonk May 16, 2025 15:53

congvc-dev self-assigned this May 16, 2025

congvc-dev linked an issue May 16, 2025 that may be closed by this pull request

support Android native project #38

Open

congvc-dev marked this pull request as ready for review May 16, 2025 15:57

JSMonk reviewed May 18, 2025

View reviewed changes

Comment thread ...e-plugin/src/main/kotlin/org/jetbrains/compose/storytale/plugin/AndroidStorytaleExtension.kt Outdated

Merge AndroidApplicationStorytaleGradlePlugin into StoryGradlePlugin

039cbfe

congvc-dev marked this pull request as draft May 18, 2025 15:41

apply spotless

85d4925

JSMonk reviewed May 25, 2025

View reviewed changes

eymar reviewed May 26, 2025

View reviewed changes

Conversation

congvc-dev commented May 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

JSMonk commented May 18, 2025

Uh oh!

congvc-dev commented May 18, 2025

Uh oh!

rin0chan commented May 20, 2025

Uh oh!

congvc-dev commented May 20, 2025

Uh oh!

congvc-dev commented May 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eymar May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eymar May 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

congvc-dev commented May 16, 2025 •

edited

Loading

eymar May 26, 2025 •

edited

Loading

eymar May 26, 2025 •

edited

Loading