Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lgrignon/jsweet-maven-plugin
JSweet maven plugin providing build and clean operations of JSweet sources
https://github.com/lgrignon/jsweet-maven-plugin
Last synced: about 7 hours ago
JSON representation
JSweet maven plugin providing build and clean operations of JSweet sources
- Host: GitHub
- URL: https://github.com/lgrignon/jsweet-maven-plugin
- Owner: lgrignon
- License: apache-2.0
- Created: 2015-12-04T17:53:24.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-10-10T06:28:30.000Z (about 1 year ago)
- Last Synced: 2023-10-10T07:32:19.398Z (about 1 year ago)
- Language: Java
- Size: 156 KB
- Stars: 18
- Watchers: 5
- Forks: 20
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSweet maven plugin
Unleash the power of JSweet into your maven project
## Table of Contents
1. [Basic Configuration](#basic-configuration)
2. [Run JSweet](#run-jsweet)
3. [Hot transpilation](#hot-transpilation)
4. [Advanced configuration](#advanced-configuration)
## Basic Configuration ##
Add the JSweet's plugin repositories to your project's pom.xml:
```xml
jsweet-plugins-release
plugins-release
http://repository.jsweet.org/artifactory/plugins-release-local
jsweet-plugins-snapshots
plugins-snapshot
http://repository.jsweet.org/artifactory/plugins-snapshot-local
```
Configure your pom's sourceDirectory, as usual:
```xml
src
```
Add your JSweet dependencies (candies):
```xml
org.jsweet.candies
angular
1.4.1-SNAPSHOT
```
Enable the JSweet transpiler plugin for the preferred phase (here, generate-sources):
```xml
org.jsweet
jsweet-maven-plugin
3.0.0
javascript
ES6
generate-js
generate-sources
jsweet
```
The configuration options of the plugin:
Name | Type | Values | Default
-------- | ------------- | ------ | -------
targetVersion | enum | ES3, ES5, ES6 | ES3
module | enum | Any of the ModuleKind enum's values (e.g. none, commonjs, umd, es2015). | none
moduleResolution | enum | The module resolution strategy (classic, node). | classic
outDir | string | JS files output directory | target/js
tsOut | string | Specify where to place generated TypeScript files. | target/ts
tsOnly | boolean | Do not compile the TypeScript output (let an external TypeScript compiler do so). | false
tsserver | boolean | Faster ts2js transpilation using tsserver | false
includes | string[] | Java source files to be included | -
excludes | string[] | Source files to be excluded | -
bundle | boolean | Bundle up all the generated code in a single file, which can be used in the browser. The bundle files are called 'bundle.ts', 'bundle.d.ts', or 'bundle.js' depending on the kind of generated code. NOTE: bundles are not compatible with any module kind other than 'none'. | false
sourceMap | boolean | Generate source map files for the Java files, so that it is possible to debug Java files directly with a debugger that supports source maps (most JavaScript debuggers). | true
sourceRoot | string | Specify the location where debugger should locate Java files instead of source locations. Use this flag if the sources will be located at run-time in a different location than that at design-time. The location specified will be embedded in the sourceMap to direct the debugger where the source files will be located. | -
compileSourceRootsOverride | string | Specify other source location/s instead of default source locations. Use this flag if the sources will be generated/preprocessed at build-time to a non standard location. | default compile sources
encoding | string | Force the Java compiler to use a specific encoding (UTF-8, UTF-16, ...). | UTF-8
noRootDirectories | boolean | Skip the root directories (i.e. packages annotated with @jsweet.lang.Root) so that the generated file hierarchy starts at the root directories rather than including the entire directory structure. | false
enableAssertions | boolean | Java 'assert' statements are transpiled as runtime JavaScript checks. | false
verbose | boolean | Turn on general information logging (INFO LEVEL). | false
veryVerbose | boolean | Turn on all levels of logging. | false
jdkHome | string | Set the JDK home directory to be used to find the Java compiler. If not set, the transpiler will try to use the JAVA_HOME environment variable. Note that the expected JDK version is greater or equals to version 8. | ${java.home}
declaration | boolean | Generate the d.ts files along with the js files, so that other programs can use them to compile. | false
dtsOut | string | Specify where to place generated d.ts files when the declaration option is set (by default, d.ts files are generated in the JavaScript output directory - next to the corresponding js files). | outDir
candiesJsOut | string | Specify where to place extracted JavaScript files from candies. | -
ingoreDefinitions | boolean | Ignore definitions from def.* packages, so that they are not generated in d.ts definition files. If this option is not set, the transpiler generates d.ts definition files in the directory given by the tsout option. | false
factoryClassName | string | Use the given factory to tune the default transpiler behavior. | -
header | file | A file that contains a header to be written at the beginning of each generated file. If left unspecified, JSweet will generate a default header. | -
workingDir | directory | The directory JSweet uses to store temporary files such as extracted candies. JSweet uses '.jsweet' if left unspecified. | -
disableSinglePrecisionFloats | boolean | By default, for a target version >=ES5, JSweet will force Java floats to be mapped to JavaScript numbers that will be constrained with ES5 Math.fround function. If this option is true, then the calls to Math.fround are erased and the generated program will use the JavaScript default precision (double precision). | false
extraSystemPath | string | Allow an extra path to be added to the system path. | -
ignoredProblems | string[] | Array of JSweetProblems which won't be reported or cause failure. | -
## Run JSweet ##
Then, just run the maven command line as usual:
```
$ mvn generate-sources -P client
```
## Hot transpilation ##
JSweet maven plugin is now able to watch changes in your JSweet files and transpile them on the fly. Try it with
```
mvn jsweet:watch
```
## Advanced configuration ##
You can use the plugin with profiles in order to transpile differently several parts of
your application. For instance, a node server and a HTML5 client app:
```xml
client
org.jsweet
jsweet-maven-plugin
3.0.0
client/out.js
ES6
**/*.java
**/server/**
generate-js
generate-sources
jsweet
server
org.jsweet
jsweet-maven-plugin
3.0.0
server/full.js
commonjs
ES5
**/*.java
**/app/**
generate-js
generate-sources
jsweet
```
then run the desired profile:
```
$ mvn generate-sources -P client
```
### Use with code generators / preprocessors
When using some code generators/preprocessors (eg: [Project Lombok](https://projectlombok.org/setup/maven)) the code is not ready for JSweet fully yet (eg: there are custom annotations to handle beforehand).
To let JSweet use a non default source directory, the compileSourceRootsOverride config element can be used, for instance with Lombok:
```xml
org.projectlombok
lombok-maven-plugin
1.18.12.0
generate-sources
delombok
false
src/main/java
org.jsweet
jsweet-maven-plugin
3.0.0
target/generated-sources/delombok
target/generated-sources/delombok
javascript
ES5
generate-js
generate-sources
jsweet
```