line / thrift-gradle-plugin Goto Github PK

Gradle Thrift Plugin uses thrift compiler to compile Thrift IDL files. This project is forked from jruyi/thrift-gradle-plugin.
It is open-sourced and licensed under Apache License 2.0 by LINE Corporation.

To use this plugin, add the following to your build script.

plugins {
    id "com.linecorp.thrift-gradle-plugin" version "0.6.1"
}

Or using legacy plugin application.

buildscript {
    repositories {
        maven {
            url = uri("https://plugins.gradle.org/m2/")
        }
    }
    dependencies {
        classpath("com.linecorp.thrift-gradle-plugin:com.linecorp.thrift-gradle-plugin.gradle.plugin:0.6.1")
    }
}

apply plugin: "com.linecorp.thrift-gradle-plugin"

See the examples/java-project directory for a very simple example.

None.

The Thrift plugin adds compileThrift task which compiles Thrift IDL files using thrift compiler. You can use thrift extension to configure the added compileThrift task.

If createGenFolder is set to false, no gen-* folder will be created.

sourceDir is only used for backward compatibility

sourceItems are a set of sources, which will be used for generating java files from thrift. A source can either be a path specified as a string or a file. In case a source is a relative path the source will be relative to srcDir. In case a source is a directory, the directory will be scanned recursively for *.thrift files and used.

When autoDetectPlugin is true, generator 'java' will be created and the generated java code will be added to Java source automatically. And the task will be added to compileJava task's dependency. We can disable this by setting autoDetectPlugin to false.

compileThrift {
    recurse true

    generator 'html'
    generator 'java', 'private-members'
}

You can create a custom task by extending CompileThrift with the following properties. Plugin will set default values to the properties listed in Table-3.

Below example is creating a custom task by extending CompileThrift and add it to compileJava task's dependency.

tasks.register("customCompileThrift", com.linecorp.thrift.plugin.CompileThrift) {
    thriftExecutable = "../../lib/thrift/0.17.0/thrift.${osdetector.classifier}"
    sourceItems.from(layout.projectDirectory.dir("src/main/thrift"))
    outputDir.set(layout.buildDirectory.dir("gen-gen-src"))
    generators.put('java', 'private-members')
}

tasks.named("compileJava") {
    dependsOn("customCompileThrift")
}