KiteConfig/io.github.yuroyami.kiteconfig/KiteConfigValues

KiteConfigValues

interface KiteConfigValues

Everything KiteConfig resolved, as a read-only view.

Reach it from any build file with the kiteConfig accessor. Every member is a lazy Provider, so wiring one into another task's property never forces a value at configuration time.

Reading a value

These accessors supply no defaults and never return null. A value the root build file never declared has no value at all, and reading it fails the build:

kiteConfig.version.get()   // declared     -> the value
                           // not declared -> throws, the build stops

That is deliberate. Reading a value the root never set is a mistake in the consuming build file, and a silent fallback would put a second copy of the value in the consumer, which is what this plugin exists to prevent.

Inheritors

KiteConfigExtension

Properties

androidApplicationId

abstract val androidApplicationId: Provider<String>

Android application id: the effective appId for Android. See appNameFor.

abstract val appId: Provider<String>

The declared base identifier, before any platform suffix or override.

abstract val appName: Provider<String>

The declared app name, before any platform corner overrides it.

canonicalLocales

abstract val canonicalLocales: Provider<List<String>>

Normalized, de-duplicated locale tags.

abstract val compileSdk: Provider<Int>

Android API level the app compiles against.

desktopBuildNumber

abstract val desktopBuildNumber: Provider<String>

The resolved desktop build number.

desktopBundleId

abstract val desktopBundleId: Provider<String>

Desktop bundle id: the effective appId for desktop.

abstract val iosBuildNumber: Provider<String>

The resolved Apple build number, CFBundleVersion.

abstract val iosBundleId: Provider<String>

Apple bundle id: the effective appId for iOS. See appNameFor.

iosMarketingVersion

abstract val iosMarketingVersion: Provider<String>

The resolved Apple marketing version, CFBundleShortVersionString.

abstract val jvmTarget: Provider<Int>

The Java release level applied to JVM compilation.

abstract val jvmToolchain: Provider<Int>

The JDK major version the build uses, when jvm { toolchain } selected one.

abstract val minSdk: Provider<Int>

Lowest Android API level the app runs on.

abstract val ndk: Provider<String>

Pinned Android NDK version, in Android's major.minor.build form.

resolvedSharedProjectPath

abstract val resolvedSharedProjectPath: Provider<String>

The selected shared KMP project path.

abstract val targetSdk: Provider<Int>

Android API level the app targets.

abstract val version: Provider<String>

The declared version string, for example 1.4.0.

abstract val versionCode: Provider<Int>

The resolved Android versionCode for this build.

Functions

abstract fun appIdFor(platform: KitePlatform): Provider<String>

The identifier resolved for platform: that platform's own appId, or the shared one plus that platform's suffix.

abstract fun appNameFor(platform: KitePlatform): Provider<String>

The app name resolved for platform, with its corner override applied.