chore: better docs for compiler (#207)

grpc · Dec 3, 2020 · 3cd2fe4 · 3cd2fe4
1 parent 8eba4ad
commit 3cd2fe4
Showing 1 changed file with 120 additions and 19 deletions.
diff --git a/compiler/README.md b/compiler/README.md
@@ -1,55 +1,156 @@
 gRPC Kotlin Codegen Plugin for Protobuf Compiler
-==============================================
+================================================
 
 This generates the Kotlin interfaces out of the service definition from a
 `.proto` file. It works with the Protobuf Compiler (`protoc`).
 
-Normally you don't need to compile the codegen by yourself, since pre-compiled
-binaries for common platforms are available on Maven Central:
+### Build Tool Plugins
 
-1. Navigate to https://mvnrepository.com/artifact/io.grpc/protoc-gen-grpc-kotlin
-2. Select a package version
-3. Click "Files: View All"
+Usually this compiler is used via a build tool plugin, like in Gradle, Maven, etc.
 
-However, if the pre-compiled binaries are not compatible with your system,
-you may want to build your own codegen.
+For Gradle, include the [protobuf plugin](https://github.com/google/protobuf-gradle-plugin) with at least version `0.8.13`, like:
+```
+plugins {
+    id("com.google.protobuf") version "SOME_VERSION"
+}
+```
 
-## System requirement
+Add dependencies on either `grpc-kotlin-stub` or `grpc-kotlin-stub-lite` like:
+```
+dependencies {
+    implementation("io.grpc:grpc-kotlin-stub:SOME_VERSION")
+}
+```
 
-* Linux, Mac OS X with Clang, or Windows with MSYS2
-* Java 7 or up
-* [Protobuf](https://github.com/google/protobuf) 3.0.0-beta-3 or up
+Finally, setup the protobuf plugin:
+```
+protobuf {
+    protoc {
+        artifact = "com.google.protobuf:protoc:SOME_VERSION"
+    }
+    plugins {
+        id("grpc") {
+            artifact = "io.grpc:protoc-gen-grpc-java:SOME_VERSION"
+        }
+        id("grpckt") {
+            artifact = "io.grpc:protoc-gen-grpc-kotlin:SOME_VERSION:jdk7@jar"
+        }
+    }
+    generateProtoTasks {
+        ofSourceSet("main").forEach {
+            it.plugins {
+                id("grpc")
+                id("grpckt")
+            }
+        }
+    }
+}
+```
+
+For Maven, include the [protobuf plugin](https://www.xolstice.org/protobuf-maven-plugin/) and configure it to use the
+`protoc-gen-grpc-kotlin` compiler, like:
+```
+<plugin>
+  <groupId>org.xolstice.maven.plugins</groupId>
+  <artifactId>protobuf-maven-plugin</artifactId>
+  <version>0.6.1</version>
+  <configuration>
+    <protocArtifact>com.google.protobuf:protoc:SOME_VERSION:exe:${os.detected.classifier}</protocArtifact>
+    <pluginId>grpc-java</pluginId>
+    <pluginArtifact>io.grpc:protoc-gen-grpc-java:SOME_VERSION:exe:${os.detected.classifier}</pluginArtifact>
+    <protocPlugins>
+      <protocPlugin>
+        <id>grpc-kotlin</id>
+        <groupId>io.grpc</groupId>
+        <artifactId>protoc-gen-grpc-kotlin</artifactId>
+        <version>SOME_VERSION</version>
+        <classifier>jdk7</classifier>
+        <mainClass>io.grpc.kotlin.generator.GeneratorRunner</mainClass>
+      </protocPlugin>
+    </protocPlugins>
+  </configuration>
+  <executions>
+    <execution>
+      <id>compile</id>
+      <goals>
+        <goal>compile</goal>
+        <goal>compile-custom</goal>
+      </goals>
+    </execution>
+  </executions>
+</plugin>
+```
 
-## Compiling and testing the codegen
+Make sure you include a dependency on `stub` or `stub-lite`, like:
+```
+<dependency>
+  <groupId>io.grpc</groupId>
+  <artifactId>grpc-kotlin-stub</artifactId>
+  <version>SOME_VERSION</version>
+</dependency>
+```
 
-Change to the `compiler` directory:
+### Manual `protoc` Usage
 
+If you want to use this compiler from `protoc` directly, you can
+[grab the latest jar distribution from Maven Central](https://repo1.maven.org/maven2/io/grpc/protoc-gen-grpc-kotlin/).
+Since the jar is not executable and `protoc` plugins must be executables, you will need to first create an executable
+that just runs that `jar`, for example create a file named `protoc-gen-grpc-kotlin.sh` with the following contents:
 ```
-$ cd $GRPC_KOTLIN_ROOT/compiler
+#!/usr/bin/env sh
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"
+java -jar $DIR/protoc-gen-grpc-kotlin-SOME_VERSION-jdk7.jar "$@
 ```
 
+Then make that file executable:
+```
+chmod +x protoc-gen-grpc-kotlin.sh
+```
+
+Now you can use the `protoc-gen-grpc-kotlin` as a plugin for `protoc`, like:
+```
+protoc --plugin=protoc-gen-grpckt=protoc-gen-grpc-kotlin.sh \
+  --grpckt_out="$OUTPUT_FILE" --proto_path="$DIR_OF_PROTO_FILE" "$PROTO_FILE"
+```
+
+## Developer Info
+
+* Linux, Mac OS X with Clang, or Windows with MSYS2
+* Java 7 or up
+* [Protobuf](https://github.com/google/protobuf) 3.0.0-beta-3 or up
+
+### Compiling and testing the codegen
+
 To compile the plugin:
 
 ```
-$ ../gradlew build
+./gradlew :grpc-kotlin-compiler:build
 ```
 
 To test the plugin with the compiler:
 
 ```
-$ ../gradlew test
+./gradlew :grpc-kotlin-compiler:test
 ```
 
 You will see a `PASS` if the test succeeds.
 
 To compile a proto file and generate Kotlin interfaces out of the service definitions:
 
 ```
-$ protoc --plugin=protoc-gen-grpc-kotlin=build/artifacts/protoc-gen-grpc-kotlin \
+protoc --plugin=protoc-gen-grpckt=compiler/build/install/grpc-kotlin-compiler/bin/grpc-kotlin-compiler \
   --grpckt_out="$OUTPUT_FILE" --proto_path="$DIR_OF_PROTO_FILE" "$PROTO_FILE"
 ```
 
-## Installing the codegen to Maven local repository
+For example:
+```
+protoc --plugin=protoc-gen-grpckt=compiler/build/install/grpc-kotlin-compiler/bin/grpc-kotlin-compiler \
+  --grpckt_out=compiler/build --proto_path=compiler/src/test/proto/helloworld \
+  compiler/src/test/proto/helloworld/helloworld.proto
+```
+
+### Installing the codegen to Maven local repository
 
 This will compile a codegen and put it under your `~/.m2/repository`. This
 will make it available to any build tool that pulls codegens from Maven