navease-gradle-plugin/io.github.alimsrepo.navease.gradle/NavEaseExtension

NavEaseExtension

Configuration for the NavEase Gradle plugin. Every value has a working default, so the block is optional.

navease {
    // Pin the artifacts. Defaults to the plugin's own version.
    version = "0.2.0"

    // Set false to declare navease-runtime yourself.
    addRuntimeDependency = false

    // Where KSP writes AutoRegisterScreens.kt.
    // Defaults to io.github.alimsrepo.navease.generated.<module name>.
    generatedPackage = "com.example.app.navigation"

    // Point at local builds when developing NavEase itself.
    kspProcessorDependency = project(":navease-ksp")
    runtimeDependency = project(":navease-runtime")
}

Constructors

NavEaseExtension

constructor()

Properties

addRuntimeDependency

abstract val addRuntimeDependency: Property<Boolean>

Whether to add navease-runtime to commonMain. Defaults to true. Set to false to declare the dependency yourself.

generatedPackage

abstract val generatedPackage: Property<String>

Package for the KSP-generated AutoRegisterScreens.kt.

kspProcessorDependency

abstract val kspProcessorDependency: Property<Any>

Overrides the processor added to kspCommonMainMetadata. Defaults to io.github.alims-repo:navease-ksp:<version>; set it to project(":navease-ksp") when working inside this repository.

runtimeDependency

abstract val runtimeDependency: Property<Any>

Overrides the runtime added to commonMain. Defaults to io.github.alims-repo:navease-runtime:<version>.

version

abstract val version: Property<String>

Version used for navease-runtime and navease-ksp. Defaults to the version of the plugin itself, so the three always match.