Jetpack proto datastore - gradle config with Kotlin dsl

Question

In jetpack datastore, you have to set the gradle plugin task for generating class out of .proto files:

// build.gradle
protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:3.10.0"
    }

    // Generates the java Protobuf-lite code for the Protobufs in this project. See
    // https://github.com/google/protobuf-gradle-plugin#customizing-protobuf-compilation
    // for more information.
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                java {
                    option 'lite'
                }
            }
        }
    }
}

In my project I use Kotlin dsl for my gradle project. After trying to convert this to kotlin dsl, option property is unknown and I can't find it's alternative for kotlin kts

// build.gradle.kts
protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:3.10.0"
    }
    generateProtoTasks {
        all().forEach { task ->
            task.builtins {
                java {
                    option = "lite" // ** option is unknown **
                }
            }
        }
    }
}

score 34 · Accepted Answer · edited Feb 21 '22 at 01:27

To use Jetpack Proto Datastore use the following code for Gradle Kotlin DSL

// top of file
import com.google.protobuf.gradle.*

plugins {
    id("com.google.protobuf") version "0.8.12"
    // ...
}

val protobufVersion = "3.18.0"

dependencies {
  // ...
  implementation("com.google.protobuf:protobuf-javalite:$protobufVersion")
  implementation("androidx.datastore:datastore:1.0.0-alpha03")
}

protobuf {
    protoc {
        artifact = "com.google.protobuf:protoc:$protobufVersion"
    }
    generateProtoTasks {
        all().forEach { task ->
            task.plugins{
                create("java") {
                    option("lite")
                }
            }
        }
    }
}

works for me with latest versions end of 2022 – mr.kostua Dec 23 '22 at 09:37 — mr.kostua, Dec 23 '22 at 09:37

score 5 · Answer 2 · edited Apr 08 '22 at 10:55

5

You can use builtins too.

import com.google.protobuf.gradle.*


    generateProtoTasks {
        all().forEach { task ->
            task.builtins {
                id("java") {
                    option("lite")
                }
            }
        }
    }

edited Apr 08 '22 at 10:55

Petrus Nguyễn Thái Học

2,539
9
14

answered May 12 '21 at 02:51

Sourav Bagchi

656
7
13

what's the difference between `task.plugins` and `task.builtins`? – stefan.at.kotlin Jun 03 '23 at 13:51

score 4 · Answer 3 · answered Jan 26 '21 at 13:40

FWIW, the accepted answer put me on the right track but failed when syncing with the following error:

Unable to find method ''org.gradle.api.NamedDomainObjectContainer org.gradle.kotlin.dsl.NamedDomainObjectContainerExtensionsKt.invoke(org.gradle.api.NamedDomainObjectContainer, kotlin.jvm.functions.Function1)''
'org.gradle.api.NamedDomainObjectContainer org.gradle.kotlin.dsl.NamedDomainObjectContainerExtensionsKt.invoke(org.gradle.api.NamedDomainObjectContainer, kotlin.jvm.functions.Function1)'

So I replaced

task.plugins{
  create("java") {
    option("lite")
  }
}

with

task.plugins.create("java") {
  option("lite")
}

and it worked as expected.

Jetpack proto datastore - gradle config with Kotlin dsl

3 Answers3