https://github.com/dzuvic/jtsgen

Convert Java Types to TypeScript
https://github.com/dzuvic/jtsgen

annotation-processor java processor typescript typescript-generator

Last synced: 13 days ago
JSON representation

Convert Java Types to TypeScript

• Host: GitHub
• URL: https://github.com/dzuvic/jtsgen
• Owner: dzuvic
• License: other
• Created: 2017-04-05T14:13:24.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2021-07-25T18:17:04.000Z (over 4 years ago)
• Last Synced: 2024-04-14T07:19:09.656Z (almost 2 years ago)
• Topics: annotation-processor, java, processor, typescript, typescript-generator
• Language: Java
• Homepage:
• Size: 1.1 MB
• Stars: 37
• Watchers: 5
• Forks: 10
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# _jtsgen_: Convert Java Types to TypeScript

**tl;dr** Enable code completion of Java types in your TypeScript project.

Annotations: [![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/https/oss.sonatype.org/com.github.dzuvic/jtsgen-annotations.svg)](https://search.maven.org/#artifactdetails|com.github.dzuvic|jtsgen-annotations)

 Processor: [![Sonatype Nexus (Releases)](https://img.shields.io/nexus/r/https/oss.sonatype.org/com.github.dzuvic/jtsgen-processor.svg)](https://search.maven.org/#artifactdetails|com.github.dzuvic|jtsgen-processor)

 [ ![Download](https://travis-ci.org/dzuvic/jtsgen.svg?branch=master) ](https://travis-ci.org/dzuvic/jtsgen)

 [![Coverage Status](https://codecov.io/github/dzuvic/jtsgen/coverage.svg?branch=master)](https://codecov.io/github/dzuvic/jtsgen?branch=master)

 [ ![Doc](https://readthedocs.org/projects/jtsgen/badge/?version=latest )](http://jtsgen.readthedocs.io/en/latest/?badge=latest)

  

## Features

This project emits TypeScript types from Java sources.

`jtsgen` is implemented as an annotation processor, therefore it should be

easily integrated in your current build infrastructure. So here are the

prominent features:

* Emitting types and documentation from annotated Java classes and interfaces at *compile* time

* Several  module types and output variants supported

* read only and name space support

* configured at source the code location (package annotation)

## Documentation

The documentation, including an introduction and a complete list of all features, is available on:

> --> [http://jtsgen.readthedocs.io](http://jtsgen.readthedocs.io) <--

So here is a small demo:

![small demo](doc/source/images/front_demo_0.2.gif)

As you can see, if the IDE is configured correctly, the java sources are

converted immediately.

## License And Legal Notes

**No Warranty**. As stated in the GPL v3 licence, there is no warranty

of any kind by using this software.

The following licenses apply `jtsgen`:

The **annotations** are **Apache 2.0** licensed. The **other parts** of `jtsgen`,

especially the processor, are **GPLv3** licensed. The license texts are

included in the file `LICENSE`. Because `jtsgen` as a sort of a compiler

plugin you shouldn't redistribute the compiler in your projects. It's

just like using OpenJDK: the generated code is *not* affected by

it's license, so it should be safe using it in most cases. Everything in

this chapter is not a legal advice in any form.

This project has to include the following legal notes:

* Oracle and Java are registered trademarks of Oracle and/or its affiliates.

  Other names may be trademarks of their respective owners. See

  https://www.oracle.com/legal/trademarks.html for details.