README.md

Gradle Thrift Plugin

Gradle Thrift Plugin uses thrift compiler to compile Thrift IDL files.

Usage

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

buildscript {
    repositories {
        maven {
            url "https://plugins.gradle.org/m2/"
        }
    }
    dependencies {
        classpath "gradle.plugin.org.jruyi.gradle:thrift-gradle-plugin:0.4.2"
    }
}

apply plugin: "org.jruyi.thrift"

Or for Gradle 2.1+:

plugins {
    id "org.jruyi.thrift" version "0.4.2"
}

Example

See the examples/test2 directory for a very simple example.

Implicitly Applied Plugins

None.

Tasks

The Thrift plugin adds compileThrift task which compiles Thrift IDL files using thrift compiler.

Table-1 Task Properties of compileThrift

Task Property	Type	Default Value
thriftExecutable	String	thrift
sourceDir	File	projectDir/src/main/thrift
sourceItems	Object...	projectDir/src/main/thrift
outputDir	File	buildDir/generated-sources/thrift
includeDirs	Set	[]
generators	Map<String, String>	['java':''] if JavaPlugin is applied, otherwise []
nowarn	boolean	false
strict	boolean	false
verbose	boolean	false
recurse	boolean	false
debug	boolean	false
allowNegKeys	boolean	false
allow64bitsConsts	boolean	false
createGenFolder	boolean	true

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.

Example

compileThrift {
    recurse true

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

Default Behaviors

When JavaPlugin is applied, generator 'java' will be created and the generated java code will be added to Java source automatically.

Using Thrift on Travis

Ubuntu 14.04 (Trusty) provides Thrift 0.9.0. If this version fits your requirements, you can use the following .travis.yml configuration file:

language: java
dist: trusty
sudo: required
before_install:
  - sudo apt-get install thrift-compiler
script:
  - ./gradlew check
  - ./gradlew assemble

License

Gradle Thrift Plugin is licensed under the Apache License, Version 2.0.