java2typescript

Java To Typescript Converter

This tool is a Node.js application written in Typescript to convert Java source code to Typescript. The conversion usually takes a Java source package (path to the package root) and creates a copy of the folder structure of that, thereby translating all *.java files to Typescript.

The converter uses (a copy of) the Java grammar from the ANTLR4 grammar directory, which supports Java 17, however, only language features up to Java 11 are supported.

Install the tool like most other Node.js packages, by running npm i java2typescript in your project folder.

How To Use the Tool

There are two ways to execute a conversion. For convenience there's a converter script, exported as binary script when adding the converter package as dependency, which can be executed. The other way is to write an own script which imports the necessary classes and run the process from there.

The java2ts Command

When you install the tool locally in a project, you can use an NPM script to run it. Define a script in your package.json:

{
    "scripts": {
        "java2ts": "java2ts config.json"
    }
}

and run it:

npm run java2ts

in the root of your project. The config file contains everything needed by the tool and is described in detail in configuration.md.

When you install the tool globally (npm i -g java2typescript) you even can run it from everywhere, without involving NPM.

Running From Your Code

It is possible to launch a conversion from your application, by importing the JavaToTypescriptConverter class, configuring its options and then run it like this:

const configuration: IConverterConfiguration = {
    packageRoot: "../<path to package root folder>",
    ...
};

const converter = new JavaToTypescriptConverter(configuration);
await converter.startConversion();

This is almost identical how the above mentioned java2ts script does it, except for some support code to transform the config json file into the require configuration structure.

There's a dedicated repository demonstrating the use of java2typescript in both ways. Check it out: java2ts-examples.

To support iterative conversions (running the tool multiple times with the same settings) without overwriting good files (e.g. when you have fixed errors in a file) add the text /* java2ts: keep */ as the first line in such a file. The associated Java file is always parsed (for symbol resolution), but a Typescript file with that line is not overwritten anymore. A different log line is printed in the console when that is the case.

Supported Language Features

Of course there's no 1:1 translation between Java and Typescript and therefore it is important to understand what needs to be considered and what problems are to be expected. A separate document discusses these aspects: feature documentation.

Changelog

1.0.1 - 1.0.2

Small bug fixes.