Skip to content

Latest commit

 

History

History
71 lines (48 loc) · 2.66 KB

README.md

File metadata and controls

71 lines (48 loc) · 2.66 KB
Raw

✨ Gradle FlatBuffers Plugin ✨

Build Status Gradle FlatBuffers Plugin License

A Gradle plugin that aids in compiling FlatBuffers sources with Docker, written in Kotlin.

💡 Introduction

This plugin was developed originally for Exflo.

🙈 Usage

To apply the plugin, use the gradle plugin syntax:

plugins {
    id("dev.north.fortyone.flatbuffers") version "0.1.0"
}

Once the plugin is applied, you can configure it with the following options (default values are displayed below):

flatbuffers {
    dockerCommand.set("docker")
    extraDockerOptions.set("run --rm")
    flatcDockerImage.set("41north/flatbuffers:1.11.0")
    extraFlatcArgs.set("flatc")
    language.set(Language.JAVA)
    inputSources.set(emptyList())
}

A flatbuffers source set will be available like a regular java or kotlin, so you can add your source code like usual.

💻 Contribute

We welcome any kind of contribution or support to this project but before to do so:

  • Make sure you have read the contribution guide for more details on how to submit a good PR (pull request).

Also, we are not only limited to technical contributions. Things that make us happy are:

  • Add a GitHub Star to the project.
  • Tweet about this project.
  • Write a review or tutorial.

Other Gradle plugins

We have published other gradle plugins:

📬 Get in touch

Gradle FlatBuffers Plugin has been developed initially by °41North.

If you think this project would be useful for your use case and want to talk more about it you can reach out to us via our contact form or by sending an email to [email protected]. We try to respond within 48 hours and look forward to hearing from you.

✍️ License

Gradle FlatBuffers Plugin is free and open-source software licensed under the Apache 2.0 License.