feat: grab more plugin declarations

[programadorthi]

Added support to customize matches to grab more gradle plugin declarations. Some people use raw text when applying plugins. Other are using Kotlin DSL and constant fields to reuse plugin names in whole project. So, it was added fields to the plugin extension that they can be used to match plugin declarations.

For instance:

// BuildPlugins.kt
object BuildPluginIds {
    const val androidApplication = "com.android.application"
}

Kotlin DSL:

// .gradle.kts (app module)
plugins {
    id(BuildPluginIds.androidApplication)
}

// .gradle.kts (a kotlin jvm library)
plugins {
    kotlin(BuildPluginIds.kotlinJVM)
}

// .gradle.kts (an android library)
apply(plugin = BuildPluginIds.androidLibrary)

Groovy DSL:

// .gradle (app module)
plugins {
    id BuildPluginIds.androidApplication
}

// .gradle (an android library)
apply plugin: BuildPluginIds.androidLibrary

As the plugin only matches the raw text, looking for "com.android.application" by instance will never match. So, we need ask the plugin user how to matches plugins declarations in this way:

// settings.gradle
magicModules {
    rawApplicationPlugin = ["BuildPluginIds.androidApplication"]
    rawLibraryPlugins = [
        "BuildPluginIds.androidLibrary",
        "BuildPluginIds.kotlinJVM",
        "BuildPluginIds.androidDynamicFeature"
    ]
}

// settings.gradle.kts
configure<io.labs.dotanuki.magicmodules.MagicModulesExtension>() {
    rawApplicationPlugin = listOf("BuildPluginIds.androidApplication")
    rawLibraryPlugins = listOf(
        "BuildPluginIds.androidLibrary",
        "BuildPluginIds.kotlinJVM",
        "BuildPluginIds.androidDynamicFeature"
    )
}

rawApplicationPlugin - how to matches application plugins? default value is ["com.android.application"].
rawLibraryPlugins - how to matches library plugins? default values are ["com.android.library", "kotlin", "com.android.dynamic-feature", "jvm"]

There is a extra field called rawLibraryUsingApplyFrom used in scenarios when users that create a base script and apply to other modules. E.g:

// shared/kotlin.gradle
apply plugin: 'kotlin'

// shared/library.gradle
apply plugin: 'com.android.library'

// build.gradle (any kotlin library)
apply from: '../kotlin.gradle'

dependencies {
    ...
}

// build.gradle (any android library)
apply from: '../library.gradle'

dependencies {
    ...
}

So, just config the property setting how to grab them:

// settings.gradle
magicModules {
    ...
    rawLibraryUsingApplyFrom = [
        "../kotlin.gradle",
         "../library.gradle"
    ]
}

// settings.gradle.kts
configure<io.labs.dotanuki.magicmodules.MagicModulesExtension>() {
    ...
    rawLibraryUsingApplyFrom = listOf(
        "../kotlin.gradle",
         "../library.gradle"
    )
}

[ubiratansoares]

@programadorthi Thanks for the PR! Looks REALLY good, you've managed to tackle one improvement I was just too lazy to deliver 😹

I've requested two small changes, most cosmetic. I've added one question as well.

[ubiratansoares]

Could you share the practical reasons why the instances now are created per settings evaluation?

[programadorthi]

The main reason is that plugin configurations are lazy. When we apply a plugin, the apply function is called at the same time and only default values are available in the configuration lifecycle. So, we have to use a lazy function as doLast, settingsEvaluated, in this case, to get custom values.

[ubiratansoares]

Makes sense to me!

[ubiratansoares]

👏👏👏👏👏

[ubiratansoares]

I will prefer not depend on the extension here. Could you please change this constructor and pass the list of raw plugins directly?

I know we'll have to wire things at plugin entry point level, but I think this abstraction becomes better!

[programadorthi]

Alright. I'll change.

[programadorthi]

I created a data class to parse the raw contents to Parser. Reasons:

1. Avoid ProjectStructureParser constructor with 3 parameters of the same type;
2. Avoid constructor to have long parameter list;
3. Improve maintenance.