Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/darylteo/vertx-gradle-plugin
Gradle Plugin for starting Vert.x projects
https://github.com/darylteo/vertx-gradle-plugin
Last synced: about 2 months ago
JSON representation
Gradle Plugin for starting Vert.x projects
- Host: GitHub
- URL: https://github.com/darylteo/vertx-gradle-plugin
- Owner: darylteo
- Created: 2013-02-24T07:29:21.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-09-26T14:20:12.000Z (almost 10 years ago)
- Last Synced: 2024-02-07T19:54:05.551Z (5 months ago)
- Language: Groovy
- Homepage:
- Size: 1.68 MB
- Stars: 18
- Watchers: 6
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Lists
- awesome-gradle - vertx-gradle-plugin - Unofficial plugin for starting Vert.x projects. (Plugins / Java application development)
README
# Vert.x Gradle Plugin
Unofficial Gradle plugin for Vert.x projects.
## Version
Latest version is 0.1.3
```
com.darylteo.vertx:vertx-gradle-plugin:0.1.3
```
## Getting Started
To get started, view the [barebones project](samples/bare-project).
## Sample Script
```groovy
buildscript {
repositories {
mavenCentral()
mavenLocal()
}
dependencies {
classpath 'com.darylteo.vertx:vertx-gradle-plugin:0.1.3'
}
}
repositories {
mavenCentral()
}
group 'com.darylteo'
version '0.1.0-SNAPSHOT'
apply plugin: 'java'
apply plugin: 'maven'
apply plugin: 'vertx'
vertx {
platform {
version '2.1RC3'
tools '2.0.3-final'
}
config { main 'Main' }
deployments {
mod {
platform {
version '2.1RC3'
cluster '127.0.0.1', 8080
instances 10
}
}
}
info {
groupId 'com.darylteo'
artifactId project.name
version '0.1.0-SNAPSHOT'
description 'Java sample project for the vert.x gradle plugin'
developers {
developer {
id 'darylteo'
name 'Daryl Teo'
email '[email protected]'
}
}
licenses {
license {
name 'The Apache Software License, Version 2.0'
url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
distribution 'repo'
}
}
properties { keywords 'Hello,World,How,Are,You?' }
}
}
configurations {
archives
}
artifacts {
archives modZip
}
uploadArchives {
repositories {
mavenDeployer {
pom.withXml {
asNode().children().addAll vertx.info
}
}
}
}
install {
repositories {
mavenInstaller {
pom.withXml {
asNode().children().addAll vertx.info
}
}
}
}
````
## Documentation
### Platform Configuration
#### Platform Version
Specify which version of Vert.x you're using. If running unit tests, you may also specify the version of testtools.
```groovy
vertx {
platform {
// version {versionString}
version '2.1RC3'
// tools {toolsVersionString}
tools '2.0.3-final'
}
}
````
#### Language Module
If you are using one of static-typed languages (other than Java) supported by Vert.x, just specify which language you require. This is useful when compiling under IDEs as the required Jars will be added by Gradle.
```groovy
vertx {
platform {
// ... platform configuration
// lang {{langName}}
lang 'scala'
lang 'groovy'
}
}
````
If you are not using a officially supported language, no worries! Simply add a langs.properties in the conf/ directory. For more information, see Vertx Configuration.
### Module Configuration
Configure your module through the _config_ section. All vert.x fields are supported.
```groovy
vertx {
config {
main 'Main'
includes 'some.other~module~version', 'another~module~version'
deploys 'some.other~module~version', 'another~module~version'
// camelcased names - autoRedeploy instead of auto-redeploy
worker false
multiThreaded false
preserveCwd false
autoRedeploy false
resident false
system false
}
}
```
Provide relevant for your module using the _info_ section, using standard Maven fields. This information will be included in the generated mod.json and can also be used for pom descriptors (example below).
#### Example
```groovy
vertx {
info {
description 'Java sample project for the vert.x gradle plugin'
developers {
developer {
id 'darylteo'
name 'Daryl Teo'
email '[email protected]'
}
developer {
id 'codemonkey'
name 'Code Monkey'
email '[email protected]'
}
}
licenses {
license {
name 'The Apache Software License, Version 2.0'
url 'http://www.apache.org/licenses/LICENSE-2.0.txt'
distribution 'repo'
}
}
properties { keywords 'Hello,World,How,Are,You?' }
}
}
````
#### mod.json
The generated mod.json will contain information from both _config_ and _info_ sections, using vert.x appropriate field names.
```javascript
{
"description": "Java sample project for the vert.x gradle plugin",
"licenses": [
"The Apache Software License, Version 2.0"
],
"keywords": [
"Hello",
"World",
"How",
"Are",
"You?"
],
"author": "Daryl Teo",
"developers": [
"Code Monkey"
],
"main": "Main",
"auto-redeploy": true
}
````
### Deployments
Setup deployment profiles for your project.
__Incubating Features__
- change deployment target
- multiple targets per deployment
- auto-redeploy rebuilds without requiring IDE (using watcher)
__Example__
```groovy
vertx {
platform { // ... }
deployments {
mod {
platform {
cluster '127.0.0.1', 8080
instances 10
}
}
modWithConf {
debug true
config {
hello 'World'
'foo-bar' 'bar-foo'
}
}
}
}
````
By default, a deployment called "mod" is automatically created and you may alter this. However, you may add as many new ones as you wish.
__Running__
Each deployment configuration you create comes with 2 Gradle tasks _run_ and _debug_. Calling the debug task allows you to use remote debugging.
Refer to documentation from your preferred IDE regarding remote debugging configuration.
__Auto Redeploy__
Module configuration includes a field "autoRedeploy" (or "auto-redeploy" in standard vert.x). Setting this field to true will enable the "watcher" task, which will automatically rebuild your project when its source files changes.
#### Platform Configuration
- Incubating Feature: This plugin allows you to configure the parameters of vertx runtime.
```groovy
vertx {
deployments {
mod {
platform {
// use this to deploy this module on a different version of vertx other than what it was built with.
// useful for testing compatibility with other versions
version '2.1RC3'
// equivalent to -cluster -cluster-host 127.0.0.1 -cluster-port 8080
cluster '127.0.0.1', 8080
// equivalent to -instances 10
instances 10
// specify a file to pass as the -conf parameter. This file is found from the root project's working directory
conf 'dev.json'
/* extra properties */
// append a path to the jvm classpath - potentially useful to specify a different directory for common vert.x configurations
classpath 'common/'
}
}
}
}
````
### Vert.x Configuration
Vert.x looks for various files for its configurations. These include:
- langs.properties
- logging.properties
- cluster.xml
- repos.txt
This plugin automatically adds conf/ to the classpath if it exists, so you can place the files there. Putting langs.properties in this folder, in particular, allows you to run unofficial language modules in your application.
### Maven
This plugin takes the approach of not selecting your preferred method of configuring Maven, due to the number of options available to people. However, this plugin makes it easy for you to publish Vert.x modules to Maven if you desire so. Other repositories may be supported, however they have not been tested (e.g. BinTray, Ivy).
For more information on publishing to Maven, refer to the Gradle [documentation](http://www.gradle.org/docs/current/userguide/userguide_single.html)
#### Artifacts
Vertx-gradle-plugin creates a _modZip_ task that you may simply add to your artifacts.
__Maven Plugin__
```groovy
configurations {
archives
}
artifacts {
archives modZip
}
````
__Maven Publish__
```groovy
publishing {
publications {
mavenJava(MavenPublication) {
from components.java
artifact modZip
}
}
}
````
#### Maven Pom
You can use the same info you specified for your project to generate your Maven poms.
__Maven Plugin__
```groovy
uploadArchives {
repositories {
mavenDeployer {
pom.withXml {
asNode().children().addAll vertx.info
}
}
}
}
install {
repositories {
mavenInstaller {
pom.withXml {
asNode().children().addAll vertx.info
}
}
}
}
````
__Maven Publish__
```groovy
publishing {
publications {
mavenJava(MavenPublication) {
pom.withXml {
asNode().children().addAll vertx.info
}
}
}
}
````
__Result__
```xml
4.0.0
com.darylteo
vertx-gradle
0.1.0-SNAPSHOT
Java sample project for the vert.x gradle plugin
darylteo
Daryl Teo
[email protected]
codemonkey
Code Monkey
[email protected]
The Apache Software License, Version 2.0
http://www.apache.org/licenses/LICENSE-2.0.txt
repo
Hello,World,How,Are,You?
````