BuildConfig for Kotlin Multiplatform Project.
It currently supports embedding values from gradle file.
Passing values from Android/iOS or any other platform code should work, but it's a hassle.
Setting up Android to read values from properties and add those into BuildConfig, and do the equivalent in iOS?
Rather I'd like to do it once.
- Kotlin 1.3.61 or later
- Kotlin Multiplatform Project
- Gradle 5.3.1 or later
buildScript {
repositories {
jcenter()
}
dependencies {
classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.61'
classpath 'com.codingfeline.buildkonfig:buildkonfig-gradle-plugin:latest_version'
}
}
apply plugin: 'org.jetbrains.kotlin.multiplatform'
apply plugin: 'com.codingfeline.buildkonfig'
kotlin {
// your target config...
android()
iosX64('ios')
}
buildkonfig {
packageName = 'com.example.app'
defaultConfigs {
buildConfigField 'STRING', 'name', 'value'
}
}
packageName
Set the package name where BuildKonfig is being placed. Required.defaultConfigs
Set values which you want to have in common. Required.
To generate BuildKonfig files, run generateBuildKonfig
task.
This task will be automatically run upon execution of kotlin compile tasks.
Above configuration will generate following simple object.
// commonMain
package com.example.app
internal object BuildKonfig {
val name: String = "value"
}
If you want to change value depending on your targets, you can use targetConfigs
to define target dependent values.
buildScript {
repositories {
jcenter()
}
dependencies {
classpath 'org.jetbrains.kotlin:kotlin-gradle-plugin:1.3.61'
classpath 'com.codingfeline.buildkonfig:buildkonfig-gradle-plugin:latest_version'
}
}
apply plugin: 'org.jetbrains.kotlin.multiplatform'
apply plugin: 'com.codingfeline.buildkonfig'
kotlin {
// your target config...
android()
iosX64('ios')
}
buildkonfig {
packageName = 'com.example.app'
// default config is required
defaultConfigs {
buildConfigField 'STRING', 'name', 'value'
}
targetConfigs {
// this name should be same as target names you specified
android {
buildConfigField 'STRING', 'name2', 'value2'
}
ios {
buildConfigField 'STRING', 'name', 'valueForNative'
}
}
}
packageName
Set the package name where BuildKonfig is being placed. Required.defaultConfigs
Set values which you want to have in common. Required.targetConfigs
Set target specific values as closure. You can overwrite values specified indefaultConfigs
.buildConfigField(String type, String name, String value)
Add new value or overwrite existing one.
Above configuration will generate following codes.
// commonMain
package com.example.app
internal expect object BuildKonfig {
val name: String
}
// androidMain
package com.example.app
internal actual object BuildKonfig {
actual val name: String = "value"
val name2: String = "value2"
}
// iosMain
package com.example.app
internal actual object BuildKonfig {
actual val name: String = "valueForNative"
}
Yes(sort of).
Kotlin Multiplatform Project does not support product flavor. Kotlin/Native part of the project has release/debug distinction, but it's not global.
So to mimick product flavor capability of Android, we need to provide additional property in order to determine flavors.
Specify default flavor in your gradle.properties
# ROOT_DIR/gradle.properties
buildkonfig.flavor=dev
// ./mpp_project/build.gradle
buildkonfig {
packageName = 'com.example.app'
// default config is required
defaultConfigs {
buildConfigField 'STRING', 'name', 'value'
}
// flavor is passed as a first argument of defaultConfigs
defaultConfigs("dev") {
buildConfigField 'STRING', 'name', 'devValue'
}
targetConfigs {
android {
buildConfigField 'STRING', 'name2', 'value2'
}
ios {
buildConfigField 'STRING', 'name', 'valueIos'
}
}
// flavor is passed as a first argument of targetConfigs
targetConfigs("dev") {
ios {
buildConfigField 'STRING', 'name', 'devValueIos'
}
}
}
In a development phase you can change value in gradle.properties
as you like.
In CI environment, you can pass value via CLI $ ./gradlew build -Pbuildkonfig.flavor=release
If you configure same field across multiple defaultConfigs and targetConfigs, flavored targetConfigs is the strongest.
Lefter the stronger.
Flavored TargetConfig > TargetConfig > Flavored DefaultConfig > DefaultConfig
- String
- Int
- Long
- Float
- Boolean
Have a look at ./sample
directory.
# Publish the latest version of the plugin to mavenLocal()
$ ./gradlew install
# Try out the samples.
# BuildKonfig will be generated in ./sample/build/buildkonfig
$ ./gradlew -p sample generateBuildKonfig