/*@jsxRuntime automatic @jsxImportSource react*/
const {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];
function _createMdxContent(props) {
  const _components = Object.assign({
    p: "p",
    a: "a",
    code: "code",
    em: "em",
    ul: "ul",
    li: "li",
    h2: "h2",
    pre: "pre",
    span: "span",
    ol: "ol",
    h3: "h3"
  }, props.components);
  return _jsxs(_Fragment, {
    children: [_jsx(_components.p, {
      children: "Eclipse Vert.x is a ver­sa­tile toolkit, and as such it does not have any strong opin­ion on the tools that you should be using."
    }), "\n", _jsxs(_components.p, {
      children: ["Gra­dle is a pop­u­lar build tool in the JVM ecosys­tem, and it is quite easy to use for build­ing Vert.x project as ", _jsxs(_components.a, {
        href: "https://github.com/vert-x3/vertx-examples/blob/master/gradle-verticles/gradle-verticle/build.gradle",
        children: ["show in one of the ", _jsx(_components.code, {
          children: "vertx-examples"
        }), " sam­ples"]
      }), " where a so-​called ", _jsx(_components.em, {
        children: "fat Jar"
      }), " is being pro­duced."]
    }), "\n", _jsxs(_components.p, {
      children: ["The new ", _jsx(_components.a, {
        href: "https://plugins.gradle.org/plugin/io.vertx.vertx-plugin",
        children: "Vert.x Gra­dle plugin"
      }), " of­fers an ", _jsx(_components.em, {
        children: "opin­ion­ated"
      }), " plug­in for build­ing Vert.x ap­pli­ca­tions with Gra­dle."]
    }), "\n", _jsx(_components.p, {
      children: "It au­to­mat­i­cally ap­plies the fol­low­ing plu­g­ins:"
    }), "\n", _jsxs(_components.ul, {
      children: ["\n", _jsxs(_components.li, {
        children: [_jsx(_components.code, {
          children: "java"
        }), " (and sets the source com­pat­i­bil­ity to Java 8),"]
      }), "\n", _jsxs(_components.li, {
        children: [_jsx(_components.code, {
          children: "application"
        }), " + ", _jsx(_components.code, {
          children: "shadow"
        }), " to gen­er­ate fat Jars with all de­pen­den­cies bun­dled,"]
      }), "\n", _jsxs(_components.li, {
        children: [_jsx(_components.code, {
          children: "nebula-dependency-recommender-plugin"
        }), " so that you can omit ver­sions from mod­ules from the the Vert.x stack."]
      }), "\n"]
    }), "\n", _jsxs(_components.p, {
      children: ["The plug­in au­to­mat­i­cally adds ", _jsx(_components.code, {
        children: "io.vertx:vertx-core"
      }), " as a ", _jsx(_components.code, {
        children: "compile"
      }), " de­pen­dency, so you don’t need to do it."]
    }), "\n", _jsxs(_components.p, {
      children: ["The plug­in pro­vides a ", _jsx(_components.code, {
        children: "vertxRun"
      }), " task that can take ad­van­tage of the Vert.x auto-​reloading ca­pa­bil­i­ties, so you can just run it then have your code being au­to­mat­i­cally com­piled and re­loaded as you make changes."]
    }), "\n", _jsxs(_components.h2, {
      id: "getting-started",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#getting-started"
      }), "Getting started"]
    }), "\n", _jsxs(_components.p, {
      children: ["A min­i­mal ", _jsx(_components.code, {
        children: "build.gradle"
      }), " looks like:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-groovy",
        children: ["plugins {\n  id ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'io.vertx.vertx-plugin'"
        }), " version ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'0.0.4'"
        }), "\n}\n\nrepositories {\n  jcenter()\n}\n\nvertx {\n  mainVerticle = ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'sample.App'"
        }), "\n}\n"]
      })
    }), "\n", _jsxs(_components.p, {
      children: ["Pro­vided ", _jsx(_components.code, {
        children: "sample.App"
      }), " is a Vert.x ver­ti­cle, then:"]
    }), "\n", _jsxs(_components.ol, {
      children: ["\n", _jsxs(_components.li, {
        children: [_jsx(_components.code, {
          children: "gradle shadowJar"
        }), " builds an ex­e­cutable Jar with all de­pen­den­cies: ", _jsx(_components.code, {
          children: "java -jar build/libs/simple-project-fat.jar"
        }), ", and"]
      }), "\n", _jsxs(_components.li, {
        children: [_jsx(_components.code, {
          children: "gradle vertxRun"
        }), " starts the ap­pli­ca­tion and au­to­mat­i­cally re­com­piles (", _jsx(_components.code, {
          children: "gradle classes"
        }), ") and re­loads the code when any file under ", _jsx(_components.code, {
          children: "src/"
        }), " is being added, mod­i­fied or deleted."]
      }), "\n"]
    }), "\n", _jsxs(_components.h2, {
      id: "using-with-kotlin-or-groovy-or",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#using-with-kotlin-or-groovy-or"
      }), "Using with Kotlin (or Groovy, or…)"]
    }), "\n", _jsxs(_components.p, {
      children: ["The plug­in in­te­grates well with plu­g­ins that add con­fig­u­ra­tions and tasks trig­gered by the ", _jsx(_components.code, {
        children: "classes"
      }), " task."]
    }), "\n", _jsx(_components.p, {
      children: "Here is how to use the plug­in with Kotlin (re­place the ver­sion num­bers with the lat­est ones…):"
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-groovy",
        children: ["plugins {\n  id ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'io.vertx.vertx-plugin'"
        }), " version ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'x.y.z'"
        }), "\n  id ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'org.jetbrains.kotlin.jvm'"
        }), " version ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'a.b.c'"
        }), "\n}\n\nrepositories {\n  jcenter()\n}\n\ndependencies {\n  compile ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'io.vertx:vertx-lang-kotlin'"
        }), "\n  compile ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'org.jetbrains.kotlin:kotlin-stdlib-jre8'"
        }), "\n}\n\nvertx {\n  mainVerticle = ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"sample.MainVerticle\""
        }), "\n}\n\ntasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).all {\n  kotlinOptions {\n    jvmTarget = ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"1.8\""
        }), "\n  }\n}\n"]
      })
    }), "\n", _jsxs(_components.h2, {
      id: "using-with-webpack-or-any-other-custom-task",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#using-with-webpack-or-any-other-custom-task"
      }), "Using with WebPack (or any other custom task)"]
    }), "\n", _jsxs(_components.p, {
      children: ["Web­Pack is pop­u­lar to bun­dle web as­sets, and there is even ", _jsx(_components.a, {
        href: "https://guides.gradle.org/running-webpack-with-gradle/",
        children: "a guide for its in­te­gra­tion with Gra­dle"
      }), "."]
    }), "\n", _jsxs(_components.p, {
      children: ["Mix­ing the Vert.x Gra­dle plug­in with Web­Pack is very sim­ple, es­pe­cially in com­bi­na­tion with the ", _jsx(_components.code, {
        children: "com.moowork.node"
      }), " plug­in that in­te­grates Node into Gra­dle."]
    }), "\n", _jsxs(_components.p, {
      children: ["Sup­pose we want to mix Vert.x code and JavaScript with Gra­dle and Web­Pack.\nWe as­sume a ", _jsx(_components.code, {
        children: "package.json"
      }), " as:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-javascript",
        children: ["{\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"name\""
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"webpack-sample\""
        }), ",\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"version\""
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"0.0.1\""
        }), ",\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"description\""
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"A sample with Vert.x, Gradle and Webpack\""
        }), ",\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"main\""
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"src/main/webapp/index.js\""
        }), ",\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"scripts\""
        }), ": {\n    ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"test\""
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"echo \\\"Error: no test specified\\\" && exit 1\""
        }), "\n  },\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"author\""
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"\""
        }), ",\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"license\""
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"ISC\""
        }), ",\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"devDependencies\""
        }), ": {\n    ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"webpack\""
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"^2.7.0\""
        }), "\n  },\n  ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"dependencies\""
        }), ": {\n    ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"axios\""
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"^0.16.2\""
        }), "\n  }\n}\n"]
      })
    }), "\n", _jsxs(_components.p, {
      children: ["and ", _jsx(_components.code, {
        children: "webpack.config.js"
      }), " as:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-javascript",
        children: [_jsx(_components.span, {
          className: "hljs-variable language_",
          children: "module"
        }), ".", _jsx(_components.span, {
          className: "hljs-property",
          children: "exports"
        }), " = {\n  ", _jsx(_components.span, {
          className: "hljs-attr",
          children: "entry"
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'./src/main/webapp/index.js'"
        }), ",\n  ", _jsx(_components.span, {
          className: "hljs-attr",
          children: "output"
        }), ": {\n    ", _jsx(_components.span, {
          className: "hljs-attr",
          children: "filename"
        }), ": ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'./build/resources/main/webroot/bundle.js'"
        }), "\n  }\n}\n"]
      })
    }), "\n", _jsxs(_components.p, {
      children: ["The ", _jsx(_components.code, {
        children: "build.gradle"
      }), " file is the fol­low­ing:"]
    }), "\n", _jsx(_components.pre, {
      children: _jsxs(_components.code, {
        className: "hljs language-groovy",
        children: ["plugins {\n  id ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'io.vertx.vertx-plugin'"
        }), " version ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'0.0.4'"
        }), "\n  id ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'com.moowork.node'"
        }), " version ", _jsx(_components.span, {
          className: "hljs-string",
          children: "'1.2.0'"
        }), "\n}\n\nrepositories {\n  jcenter()\n}\n\ndependencies {\n  compile ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"io.vertx:vertx-web\""
        }), "\n}\n\nvertx {\n  mainVerticle = ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"sample.MainVerticle\""
        }), "\n  watch = [", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"src/**/*\""
        }), ", ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"build.gradle\""
        }), ", ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"yarn.lock\""
        }), "]\n  onRedeploy = [", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"classes\""
        }), ", ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"webpack\""
        }), "]\n}\n\ntask webpack(", _jsx(_components.span, {
          className: "hljs-attr",
          children: "type:"
        }), " Exec) {\n  inputs.file(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"$projectDir/yarn.lock\""
        }), ")\n  inputs.file(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"$projectDir/webpack.config.js\""
        }), ")\n  inputs.dir(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"$projectDir/src/main/webapp\""
        }), ")\n  outputs.dir(", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"$buildDir/resources/main/webroot\""
        }), ")\n  commandLine ", _jsx(_components.span, {
          className: "hljs-string",
          children: "\"$projectDir/node_modules/.bin/webpack\""
        }), "\n}\n"]
      })
    }), "\n", _jsxs(_components.p, {
      children: ["This cus­tom build ex­poses a ", _jsx(_components.code, {
        children: "webpack"
      }), " task that in­vokes Web­Pack, with proper file track­ing so that Gra­dle knows when the task is up-​to-date or not."]
    }), "\n", _jsxs(_components.p, {
      children: ["The Node plug­in adds many tasks, and in­te­grates fine with ", _jsx(_components.code, {
        children: "npm"
      }), " or ", _jsx(_components.code, {
        children: "yarn"
      }), ", so fetch­ing all NPM de­pen­den­cies is done by call­ing ", _jsx(_components.code, {
        children: "./gradlew yarn"
      }), "."]
    }), "\n", _jsxs(_components.p, {
      children: ["The ", _jsx(_components.code, {
        children: "vertxRun"
      }), " task now re­de­ploys on mod­i­fi­ca­tions to files in ", _jsx(_components.code, {
        children: "src/"
      }), " (and sub-​folders), ", _jsx(_components.code, {
        children: "build.gradle"
      }), " and ", _jsx(_components.code, {
        children: "yarn.lock"
      }), ", call­ing both the ", _jsx(_components.code, {
        children: "classes"
      }), " and ", _jsx(_components.code, {
        children: "webpack"
      }), " tasks:"]
    }), "\n", _jsx("div", {
      className: "youtube-embed",
      children: _jsx("iframe", {
        src: "https://www.youtube.com/embed/OGy-1w8Z6Dc?rel=0",
        frameBorder: "0",
        allowFullScreen: true
      })
    }), "\n", _jsxs(_components.h2, {
      id: "summary",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#summary"
      }), "Summary"]
    }), "\n", _jsxs(_components.p, {
      children: ["The Vert.x Gra­dle plug­in pro­vides lots of de­faults to con­fig­ure a Gra­dle project for Vert.x ap­pli­ca­tions, pro­duc­ing ", _jsx(_components.em, {
        children: "fat Jars"
      }), " and of­fer­ing a run­ning task with au­to­matic re­de­ploy­ment.\nThe plug­in also in­te­grates well with other plu­g­ins and ex­ter­nal tools for which a Gra­dle task is avail­able."]
    }), "\n", _jsx(_components.p, {
      children: "The project is still in its early stages and we are look­ing for­ward to hear­ing from you!"
    }), "\n", _jsxs(_components.h3, {
      id: "links",
      children: [_jsx(_components.a, {
        "aria-hidden": true,
        tabIndex: "-1",
        className: "heading-anchor",
        href: "#links"
      }), "Links"]
    }), "\n", _jsxs(_components.ul, {
      children: ["\n", _jsx(_components.li, {
        children: _jsx(_components.a, {
          href: "https://github.com/jponge/vertx-gradle-plugin",
          children: "The project on GitHub"
        })
      }), "\n", _jsx(_components.li, {
        children: _jsx(_components.a, {
          href: "https://plugins.gradle.org/plugin/io.vertx.vertx-plugin",
          children: "The plug­in on the Gra­dle plu­g­ins por­tal"
        })
      }), "\n"]
    })]
  });
}
function MDXContent(props = {}) {
  const {wrapper: MDXLayout} = props.components || ({});
  return MDXLayout ? _jsx(MDXLayout, Object.assign({}, props, {
    children: _jsx(_createMdxContent, props)
  })) : _createMdxContent(props);
}
return {
  default: MDXContent
};


Blog

An Eclipse Vert.x Gradle Plugin

Next post

Eclipse Vert.x 3.5.0 released!

Previous post

Introducing Vert.x MQTT client

Blog

An Eclipse Vert.x Gradle Plugin

Next post

Eclipse Vert.x 3.5.0 released!

Previous post

Introducing Vert.x MQTT client

Related posts

Unit and Integration Tests

TCP Client using Eclipse Vert.x, Kotlin and Gradle build

Checklist for Migrating from Vert.x 2.1.x to Vert.x 3 - Part One