Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bulivlad/vertx-codegen-plugin

A Gradle plugin to facilitate the codegen usage for Vert.x Java projects
https://github.com/bulivlad/vertx-codegen-plugin

codegen gradle-plugin vert-x vertx-codegen vertx3

Last synced: about 2 months ago
JSON representation

A Gradle plugin to facilitate the codegen usage for Vert.x Java projects

Host: GitHub
URL: https://github.com/bulivlad/vertx-codegen-plugin
Owner: bulivlad
License: gpl-3.0
Created: 2019-04-25T16:18:59.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2020-06-18T20:19:46.000Z (over 4 years ago)
Last Synced: 2024-04-11T06:40:08.116Z (6 months ago)
Topics: codegen, gradle-plugin, vert-x, vertx-codegen, vertx3
Language: Groovy
Homepage:
Size: 85 KB
Stars: 9
Watchers: 5
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

vertx-awesome - Vert.x Codegen Gradle plugin - A Gradle plugin to facilitate the codegen usage for Vert.x Java projects. (Build tools)

README

        # Vert.x Codegen Gradle Plugin for Java projects

A Gradle plugin to _facilitate_ the codegen usage for Vert.x Java projects

[![CircleCI](https://circleci.com/gh/bulivlad/vertx-codegen-plugin.svg?style=svg)](https://circleci.com/gh/bulivlad/vertx-codegen-plugin)

[![LICENSE](https://img.shields.io/github/license/bulivlad/vertx-codegen-plugin.svg)](https://github.com/bulivlad/vertx-codegen-plugin/blob/master/LICENSE)

[![GradlePluginPortal](https://img.shields.io/maven-metadata/v/https/plugins.gradle.org/m2/io/dotinc/vertx-codegen-plugin/io.dotinc.vertx-codegen-plugin.gradle.plugin/maven-metadata.xml.svg?label=gradlePluginPortal)](https://plugins.gradle.org/plugin/io.dotinc.vertx-codegen-plugin)

### Why is this plugin helpful

This [plugin](https://plugins.gradle.org/plugin/io.dotinc.vertx-codegen-plugin) focus on configuring your gradle project to be ready for Vert.x [Service-Proxy](https://github.com/vert-x3/vertx-service-proxy) usage. It applies the configuration needed for [CodeGen](https://github.com/vert-x3/vertx-codegen) API

### What the plugin does behind the scene

* Check if the [java](https://docs.gradle.org/current/userguide/java_plugin.html) plugin was applied and abort the execution otherwise

* Apply the following gradle dependencies with appropriate configuration with regards to the gradle version.

	* `io.vertx:vertx-core`

	* `io.vertx:vertx-service-proxy`

	* `io.vertx:vertx-codegen`

* Adds a new gradle task `cleanGenerated` which will clean the generated classes. The default `clean` task depends on `cleanGenerated`

* Adds the compiler attributes needed

| NOTE: | The plugin will only be executed if the `java` plugin was already applied. It will not forcefully apply any `plugin` behind the scenes. |

| ------------- | :------------- |

### Configuration example

```groovy

plugins {

	id 'java'

	id 'io.dotinc.vertx-codegen-plugin' version 'x.y.z' // (1)

}

repositories {

    mavenCentral()

}

codeGen {

	vertxVersion = 'a.b.c' // (2)

	generatedDirs = "src/main/generated"

	generationPath = "proxy"

}

```

(1) Replace `x.y.z` with one of the plugin versions available on the [Gradle Plugin Portal](https://plugins.gradle.org/plugin/io.dotinc.vertx-codegen-plugin)

(2) Replace `a.b.c` with one of the vert.x library versions available on [Maven Central Repository](https://mvnrepository.com/artifact/io.vertx/vertx-core)

### Configuration

| Options | Description | Default value |

| ------------- | :------------- | :-----|

| vertxVersion | The vert.x library version | 3.8.4 |

| generatedDirs | The path to the generated java classes. The path is relative to the project root | "src/main/generated" |

| generationPath | The specific path to the generated java class | "proxy" |

| |  |

| --- | --- |

| NOTE:  | Full path to generated proxy classes will be `${generatedDirs}/${generationPath}` |

| | The `vertxVersion` config will be overridden with `io.vertx:vertx-core` version if it was already included in `build.gradle` file |

The default values can also be found in [src/main/groovy/io/dotinc/gradle/CodeGenPluginExtension.groovy](https://github.com/bulivlad/vertx-codegen-plugin/blob/master/src/main/groovy/io/dotinc/gradle/CodeGenPluginExtension.groovy)

### Contributing

* Pull requests are welcome.

* PRs should target the `master` branch.

### Author

Vlad Bulimac ([email protected])