google/protobuf-gradle-plugin

Improve Documentation for Android Kotlin DSL for protobuf-javalite

Open

#518 opened on Aug 21, 2021

View on GitHub
 (9 comments) (17 reactions) (0 assignees)Groovy (1,832 stars) (287 forks)batch import
documentationhelp wanted

Description

I'm having issue converting these gradle groovy code to kotlin dsl.

protobuf {
  protoc {
    artifact = 'com.google.protobuf:protoc:3.8.0'
  }
  generateProtoTasks {
    all().each { task ->
      task.builtins {
        java {
          option "lite"
        }
      }
    }
  }
}

Especially the option "lite" in java block.

Thanks.

Contributor guide

Tech stack
javakotlin
Domain
build systemdocumentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
basic knowledge of GradleKotlin DSLprotobuf usage
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Check the README and documentation in the repository for existing Kotlin DSL examples. Specifically, look at how the 'option "lite"' is set in Groovy and find the equivalent Kotlin DSL syntax. Add a clear example to the documentation. The issue #518 user comments may provide further clues.