Git Product home page Git Product logo

java2typescript's Introduction

- This repository contains the legacy version of GreyCat. 
! DataThings crew is about to disclose a new, faster, ligher native GreyCat. Stay tuned and follow us on twitter/facebook or

Java To TypeScript Transpiler

This project is a transpiler able to transform your Java codebase to TypeScript and then to JavaScript to ultimatly run Java code in the browser.

NB: JDK 8 or below

What is it for ?

The goal of J2TS is to share a codebase between Java, TypeScript and Javascript. This is especially helpful for sharing domain classes, data structures, and complex algorithms.

What is it not for ?

The goal of J2TS is not to develop a UI in Java. There are better projects for this. J2TS focus on performance and readability of the generated TypeScript code.

Getting Started

The easiest way to get started with J2TS is using the maven plugin. Hereafter is a simple snippet of usage:

<plugin>
    <groupId>com.datathings</groupId>
    <artifactId>j2ts-mavenplugin</artifactId>
    <version>${j2ts.version}</version>
    <executions>
        <execution>
            <id>transpile</id>
            <goals>
                <goal>java2ts</goal>
            </goals>
            <configuration>
                <name>sample</name>
                <copyJRE>true</copyJRE>
            </configuration>
        </execution>
    </executions>
</plugin>

By default the Java source directory is src/main/java and the generated-sources is target/generated-sources/java2ts.

These values can be overriden as follows:

<source>${basedir}/../api/src/main/java</source>
<target>${basedir}/target/generated-sources</target>

Sample project

A full sample project is hosted here

This project can be compiled through the following command

mvn clean install

Make sure you have NodeJS, NPM and TypeScript installed on your system. To install TypeScript just tape the following command in your console:

npm i -g typescript

Then go to the target/classes directory and open the index.html in you browser to see how to use the generated code.

Limitations

Currently, in order to keep the JRE.js as lightweight as possible, only a subSet of the JRE is supported. For instance, we support most common structures sucj as ArrayList and HashMap, but not all advanced once such as ConcurrentQueue and so on. However, if you face a limitation due to the lake of one JRE class, don't worry this is very easy to extend.

In a nutshell, update the base JRE.TS file here:

transpiler/src/main/resources/java.ts

To add your class with the same name than in Java. Finally in case of inferred package please also update this class:

transpiler/src/main/java/java2typescript/helper/TypeHelper.java#L162

Finally to provide a new JRE class permanently, please do a push request.

java2typescript's People

Contributors

dukeboard avatar gnain avatar maxleiko avatar thomashartmann avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.