google/protobuf-gradle-plugin

Improve Documentation for Android Kotlin DSL for protobuf-javalite

Open

#518 geöffnet am 21. Aug. 2021

Auf GitHub ansehen
 (9 Kommentare) (17 Reaktionen) (0 zugewiesene Personen)Groovy (1.832 Stars) (287 Forks)batch import
documentationhelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
under 1 hour
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
basic knowledge of GradleKotlin DSLprotobuf usage
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.