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
Content copied to clipboard

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

Properties

Link copied to clipboard
abstract val androidApplicationId: Provider<String>

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

Link copied to clipboard
abstract val appId: Provider<String>

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

Link copied to clipboard
abstract val appName: Provider<String>

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

Link copied to clipboard
abstract val canonicalLocales: Provider<List<String>>

Normalized, de-duplicated locale tags.

Link copied to clipboard
abstract val compileSdk: Provider<Int>

Android API level the app compiles against.

Link copied to clipboard
abstract val desktopBuildNumber: Provider<String>

The resolved desktop build number.

Link copied to clipboard
abstract val desktopBundleId: Provider<String>

Desktop bundle id: the effective appId for desktop.

Link copied to clipboard
abstract val iosBuildNumber: Provider<String>

The resolved Apple build number, CFBundleVersion.

Link copied to clipboard
abstract val iosBundleId: Provider<String>

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

Link copied to clipboard
abstract val iosMarketingVersion: Provider<String>

The resolved Apple marketing version, CFBundleShortVersionString.

Link copied to clipboard
abstract val jvmTarget: Provider<Int>

The Java release level applied to JVM compilation.

Link copied to clipboard
abstract val jvmToolchain: Provider<Int>

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

Link copied to clipboard
abstract val minSdk: Provider<Int>

Lowest Android API level the app runs on.

Link copied to clipboard
abstract val ndk: Provider<String>

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

Link copied to clipboard
abstract val resolvedSharedProjectPath: Provider<String>

The selected shared KMP project path.

Link copied to clipboard
abstract val targetSdk: Provider<Int>

Android API level the app targets.

Link copied to clipboard
abstract val version: Provider<String>

The declared version string, for example 1.4.0.

Link copied to clipboard
abstract val versionCode: Provider<Int>

The resolved Android versionCode for this build.

Functions

Link copied to clipboard
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.

Link copied to clipboard
abstract fun appNameFor(platform: KitePlatform): Provider<String>

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

Link copied to clipboard
open fun debugAppIdFor(platform: KitePlatform): Provider<String>

The identifier the debug build of platform gets: its debug { } value, otherwise the release identifier from appIdFor. Desktop has no debug build, so it always answers with the release identifier.

Link copied to clipboard
open fun debugAppNameFor(platform: KitePlatform): Provider<String>

The name the debug build of platform shows: its debug { } value, otherwise the release name from appNameFor.