Setting up the plugin

Apply

You can apply the plugin to either the root or the module level build.gradle file.

Option 1: Apply to root level

plugins {
    id ("com.nomanr.plugin.lumo") version "$latest"
    // alias(libs.plugins.lumo) -- from the catalog
}

Option 2: Apply to module level

// root level build.gradle.kts
plugins {
    id ("com.nomanr.plugin.lumo") version "$latest" apply false
    // alias(libs.plugins.lumo) apply false -- from the catalog
}
 
// module level e.g. ui-components/build.gradle.kts
plugins {
    id("com.nomanr.plugin.lumo")
    // alias(libs.plugins.lumo) -- from the catalog
}

Verify

Once the gradle sync is complete, verify the plugin is integrated successfully:

./gradlew lumo --plugin-help

Initialize

Run the following command to initialize the plugin:

./gradlew lumo --init

This will create a lumo.properties file in the root of your project with default configurations. The output will also display the required dependencies that need to be added to your project’s build files.