gradle-plugin-protobuf

Gradle build plugin to handle Protocol Buffers automated code generation and compilation

License

License

Categories

Categories

Gradle Build Tools Ant Protobuf Data Data Structures
GroupId

GroupId

ws.antonov.gradle.plugins
ArtifactId

ArtifactId

gradle-plugin-protobuf
Last Version

Last Version

0.9.1
Release Date

Release Date

Type

Type

jar
Description

Description

gradle-plugin-protobuf
Gradle build plugin to handle Protocol Buffers automated code generation and compilation
Project URL

Project URL

https://github.com/aantono/gradle-plugin-protobuf
Source Code Management

Source Code Management

https://github.com/aantono/gradle-plugin-protobuf

Download gradle-plugin-protobuf

How to add to project

<!-- https://jarcasting.com/artifacts/ws.antonov.gradle.plugins/gradle-plugin-protobuf/ -->
<dependency>
    <groupId>ws.antonov.gradle.plugins</groupId>
    <artifactId>gradle-plugin-protobuf</artifactId>
    <version>0.9.1</version>
</dependency>
// https://jarcasting.com/artifacts/ws.antonov.gradle.plugins/gradle-plugin-protobuf/
implementation 'ws.antonov.gradle.plugins:gradle-plugin-protobuf:0.9.1'
// https://jarcasting.com/artifacts/ws.antonov.gradle.plugins/gradle-plugin-protobuf/
implementation ("ws.antonov.gradle.plugins:gradle-plugin-protobuf:0.9.1")
'ws.antonov.gradle.plugins:gradle-plugin-protobuf:jar:0.9.1'
<dependency org="ws.antonov.gradle.plugins" name="gradle-plugin-protobuf" rev="0.9.1">
  <artifact name="gradle-plugin-protobuf" type="jar" />
</dependency>
@Grapes(
@Grab(group='ws.antonov.gradle.plugins', module='gradle-plugin-protobuf', version='0.9.1')
)
libraryDependencies += "ws.antonov.gradle.plugins" % "gradle-plugin-protobuf" % "0.9.1"
[ws.antonov.gradle.plugins/gradle-plugin-protobuf "0.9.1"]

Dependencies

test (1)

Group / Artifact Type Version
junit : junit jar 4.8.1

Project Modules

There are no modules declared in this project.

Protobuf Plugin for Gradle

The Protobuf plugin provides protobuf compilation to your project.

Latest Version

ws.antonov.gradle.plugins:gradle-plugin-protobuf:0.9.1 - Available on Maven Central

Usage

To use the protobuf plugin, include in your build script:

apply plugin: 'protobuf'

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'ws.antonov.gradle.plugins:gradle-plugin-protobuf:0.9.1'
    }
}

// Optional - defaults to 'protoc' searching through your PATH
protocPath = '/usr/local/bin/protoc'
// Optional - defaults to value below
extractedProtosDir = "${project.buildDir.path}/extracted-protos"
// Optional - defaults to "${project.buildDir}/generated-sources/${sourceSet.name}"
generatedFileDir = "${projectDir}/src" // This directory will get the current sourceSet.name appended to it. i.e. src/main or src/test
// Optional - defaults to empty collection => []
//  If entry separated by ':', will translate into 'protoc' argument '--plugin=protoc-gen-${values[0]}=${values[1]}'
//  If entry is anything else, will translate into 'protoc' argument '--plugin=protoc-gen-${it}=${project.projectDir}/protoc-gen-${it}'
//
//  To execute the plugin, you either need to point to the full path, or have an executable shell script in the project main dir
protobufCodeGenPlugins = ['foo:./protoc-gen-foo', 'bar']

dependencies {
    // If you have your protos archived in a tar file, you can specify that as a dependency
    //   ... alternative archive types supported are: jar, tar, tar.gz, tar.bz2, zip
    protobuf files("lib/protos.tar.gz")
    // Different configuration fileSets are supported
    testProtobuf files("lib/protos.tar")
}

Versions

Version
0.9.1
0.9
0.8
0.7
0.6
0.5
0.4