Skip to content

Commit

Permalink
initial import
Browse files Browse the repository at this point in the history
  • Loading branch information
@pmlopes
pmlopes committed Mar 15, 2018
1 parent 931ef23 commit 4674a5f
Show file tree
Hide file tree
Showing 73 changed files with 3,949 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
View file
@@ -0,0 +1,9 @@
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
trim_trailing_whitespace = true
end_of_line = lf
insert_final_newline = true
8 changes: 8 additions & 0 deletions .gitignore
View file
@@ -0,0 +1,8 @@
.idea
.classpath
.project
.settings
target
*.iml
node_modules
.vscode
219 changes: 219 additions & 0 deletions README.md
View file
@@ -0,0 +1,219 @@
# Vert.x Lang ES

This is the EcmaScript (5.1+) language support for [Eclipse Vert.x](http://vertx.io)

EcmaScript (or JavaScript from now onwards) can be used with Vert.x, however it's language
level is limited to the underlying `Nashorn` engine. The engine does support `ES5.1` plus
some `ES6` features. For a full list of supported features please have a look at the
[compat-tables](https://kangax.github.io/compat-table/es6/) project, depending on your
runtime [JDK 1.8](https://kangax.github.io/compat-table/es6/#nashorn1_8) or
[JDK9](https://kangax.github.io/compat-table/es6/#nashorn9) you should have more or less
language features.

## Goals

The goals of this verticle factory are to offer a [NPM](https://www.npmjs.com) development
approach first, instead of a java project based approach. This should make the entry level
for JavaScript developers quite low, if they are coming from a `nodejs` background.

## Usage

Minimum requirements: Since `vert.x` is a JVM based runtime, it is expected that `Java`
and [Apache Maven](http://maven.apache.org) is available in the development machine. Also
it is expected that both `nodejs` and (`npm` or `yarn`) are available too.

### Bootstrapping a Project

Bootstrapping a project should be as simple as:

```sh
mkdir myproject
cd myproject
npm init -y
```

As this moment there should be a minimal `package.json`. To simplify working with `vert.x`
add the package [vertx-scripts](https://www.npmjs.com/package/vertx-scripts) to your
`devDependencies`. During install you should get a warning tip to add also a set of custom
`scripts` to your `package.json` so it looks like this:

```json
{
"name": "myproject",
"version": "0.0.1",
"main": "./index.js",
"scripts": {
"postinstall": "vertx-scripts init",
"test": "vertx-scripts launcher test -t -v",
"start": "vertx-scripts launcher run -v",
"package": "vertx-scripts package -c -v"
},
"license": "ISC",
"private": true,
"devDependencies": {
"vertx-scripts": "^1.0.7"
}
}
```

As of this moment you can follow the normal workflow. For example in order to create a
`vert.x` HTTP server using `vert.x web` you could add the following `dependencies`:

```json
{
"dependencies": {
"@vertx/core": "3.5.1",
"@vertx/web": "3.5.1"
}
}
```

And in your `index.js`:

```js
/// <reference types="@vertx/core/runtime" />
// @ts-check
import { Router } from '@vertx/web';

const app = Router.router(vertx);

app.route().handler(function (ctx) {
ctx.response().end('Hello from Vert.x Web!');
});

vertx.createHttpServer()
.requestHandler(app)
.listen(8080);
```

Note that the first 2 lines are helpful if you're using [Visual Studio Code](https://code.visualstudio.com/)
and they will give you proper type hinting and error reporting.

### Running your app

Since the package `vertx-scripts` is added to the project and the `scripts` section is using it, running your
application is as simple as:

```sh
npm start
```

### Packaging

It is common to package JVM applications as runnable `JAR` files, the `vertx-scripts` also provides this feature:

```sh
npm run package
```

And a new `JAR` file should be built in your `target` directory.

## More information

To know more details about the `vertx-scripts`, please refer to it's [manual](vertx-scripts/README.md).

## Generating your own ES bindings

If you're working on the Java side and would like to generate `JavaScript` binding for your vert.x library, all you need
is to create a new `Maven` `pom.xml` file as follows:

```xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>xyz.jetdrone</groupId>
<artifactId>vertx-lang-es-generator</artifactId>
<version>1.0</version>
</parent>

<artifactId>hot-reload</artifactId>
<version>0.0.5</version>

<packaging>jar</packaging>

<properties>
<maven.groupId>xyz.jetdrone</maven.groupId>
<!-- language=json -->
<npm-dependencies>
{
"${npm-scope}vertx": "${stack.version}",
"${npm-scope}vertx-web": "${stack.version}"
}
</npm-dependencies>
</properties>

<dependencies>
<!-- SOURCE TO GENERATE -->
<dependency>
<groupId>${maven.groupId}</groupId>
<artifactId>${project.artifactId}</artifactId>
<version>${project.version}</version>
</dependency>
<dependency>
<groupId>${maven.groupId}</groupId>
<artifactId>${project.artifactId}</artifactId>
<version>${project.version}</version>
<scope>provided</scope>
<classifier>sources</classifier>
</dependency>
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-web</artifactId>
<version>${stack.version}</version>
<optional>true</optional>
</dependency>
</dependencies>
</project>
```

Is it important to use the given parent:

```xml
<parent>
<groupId>xyz.jetdrone</groupId>
<artifactId>vertx-lang-es-generator</artifactId>
<version>1.0</version>
</parent>
```

The npm module name is extracted from the `artifactId` so in order to properly generate the code you must specify what
is the `maven.groupId` from the java project.

If the project has other dependencies they should be listed in the dependencies section as in this example `vertx-web`.

Finally if there were extra dependencies it will be good to provide that information to `NPM` so it can be achived with
a property:

```xml
<!-- language=json -->
<npm-dependencies>
{
"${npm-scope}vertx": "${stack.version}",
"${npm-scope}vertx-web": "${stack.version}"
}
</npm-dependencies>
```

The variables `npm-scope` and `stack.version` are provided by the parent pom. Once you are happy with the generated code
by running:

```sh
mvn clean package
```

You can publish it to a local `NPM` registry:

```sh
mvn install
```

or to a custom registry:

```sh
mvn -Dnpm-registry=https://registry.npmjs.org install
```
101 changes: 101 additions & 0 deletions pom.xml
View file
@@ -0,0 +1,101 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

<parent>
<groupId>org.sonatype.oss</groupId>
<artifactId>oss-parent</artifactId>
<version>9</version>
</parent>

<modelVersion>4.0.0</modelVersion>

<groupId>io.reactiverse</groupId>
<artifactId>es4x</artifactId>
<version>0.5.1-SNAPSHOT</version>

<properties>
<vertx.version>3.5.1</vertx.version>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.testTarget>1.8</maven.compiler.testTarget>
<maven.compiler.testSource>1.8</maven.compiler.testSource>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

<licenses>
<license>
<name>Apache License, Version 2.0</name>
<distribution>repo</distribution>
<url>http://www.apache.org/licenses/LICENSE-2.0.html</url>
</license>
</licenses>


<issueManagement>
<url>https://github.com/reactiverse/es4x/issues</url>
<system>GitHub Issues</system>
</issueManagement>

<scm>
<url>https://github.com/reactiverse/es4x</url>
<connection>scm:git:git://github.com/reactiverse/es4x.git</connection>
<developerConnection>scm:git:git@github.com:reactiverse/es4x.git</developerConnection>
</scm>

<dependencies>
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-core</artifactId>
<version>${vertx.version}</version>
</dependency>

<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.vertx</groupId>
<artifactId>vertx-unit</artifactId>
<version>${vertx.version}</version>
<scope>test</scope>
</dependency>
</dependencies>

<build>
<pluginManagement>
<plugins>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
</plugins>
</pluginManagement>

<plugins>
<plugin>
<groupId>com.amashchenko.maven.plugin</groupId>
<artifactId>gitflow-maven-plugin</artifactId>
<version>1.7.0</version>
<configuration>
<installProject>false</installProject>
<gitFlowConfig>
<productionBranch>master</productionBranch>
<developmentBranch>develop</developmentBranch>
<featureBranchPrefix>feature/</featureBranchPrefix>
<releaseBranchPrefix>release/</releaseBranchPrefix>
<hotfixBranchPrefix>hotfix/</hotfixBranchPrefix>
<supportBranchPrefix>support/</supportBranchPrefix>
<versionTagPrefix/>
</gitFlowConfig>
</configuration>
</plugin>
</plugins>
</build>

</project>

0 comments on commit 4674a5f

Please sign in to comment.