vertx-scripts

Vert.x Scripts

This is a helper dev package to work with Eclipse Vert.x JS/TS projects.

Included scripts:

• init
• launcher
• package
• shell

Init

Init will bootstrap a pom.xml file from the package.json. The maven pom file can be customized by supplying a handlebars template named .pom.xml.

By default both groupId and artifactId will map to the package json name property, the version will map to the version property and the main verticle will map to the main property.

All entries in files will be added to the final fatJar with the caveat that directories must be sufixed with / so maven can understand how to handle it.

In order to use this script in your project you should add the following to your package.json scripts:

{
  "scripts": {
    "postinstall": "vertx-scripts init"
  },
  
  "devDependencies": {
    "vertx-scripts": "^1.1.4"
  }
}

You can add normal dependencies as normal too.

Launcher

This script will delegate to vert.x launcher, it will invoke the command you want to run and pass all arguments to it.

There are a couple of helper.

• -d will start the JVM in debug mode listening on port 9797
• -t will use the test classpath instead of the runtime classpath

When no arguments are passed the main verticle is derived from the package.json main property. When the test classpath is enabled then this value is suffixed by .test.js.

An example running tests would be after adding vertx-unit to the devDependencies:

{
  "scripts": {
    "test": "vertx-scripts launcher test -v"
  },
  
  "devDependencies": {
    "vertx-scripts": "^1.1.4",
    "@vertx/unit": "3.5.3"
  },
  
  "dependencies": {
    "@vertx/core": "3.5.3"
  }
}

Package

This script will package your application as a fatJar so you can easily deploy it and distribute.

{
  "scripts": {
    "package": "vertx-scripts package -c"
  },
  
  "devDependencies": {
    "vertx-scripts": "^1.1.4"
  },
  
  "dependencies": {
    "@vertx/core": "3.5.3"
  }
}

Shell

Once you have your code packaged you can run it as a runnable jar or even run it using the shell. Be aware that the shell not not node but Nashorn the JVM JavaScript engine. You can run it as:

jjs -cp target/yourapp-1.0.0-fat.jar

or from the script.

Once the REPL starts you can load vert.x and your code e.g.:

// this will initialize all the Vert.x Runtime Objects
load('classpath:vertx.js');
// run your verticle:
require('path/to/your/verticle');