Skip to content

A Java API for generating typescript source files (.ts files)

License

Notifications You must be signed in to change notification settings

Flipkart/typescriptpoet

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

71 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TypeScriptPoet

Build Status

TypeScriptPoet is a Java API for generating typescript files (.ts).

Source file generation can be useful when doing things such as annotation processing or interacting with metadata files (e.g., database schemas, protocol formats). By generating code, you eliminate the need to write boilerplate while also keeping a single source of truth for the metadata.

Example

Here's a (boring) HelloWorld class:

export class HelloWorld {
  printMessage() {
    console.log("Hello World!");
  }
}

And this is the (exciting) code to generate it with TypescriptPoet:

MethodSpec main = MethodSpec.methodBuilder("printMessage")
    .addStatement("Hello World!")
    .build();

TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
    .addModifiers(Modifier.EXPORT)
    .addMethod(main)
    .build();

TypeScriptFile file = TypeScriptFile.builder("com.example.helloworld", helloWorld)
    .build();

file.writeTo(System.out);

Download

Gradle :

Add it in your root build.gradle at the end of repositories:

allprojects {
   repositories {
	...
	maven { url 'https://jitpack.io' }
   }
}

Add the dependency:

dependencies {
   compile 'com.github.Flipkart:typescriptpoet:1.0'
}

Maven :

Add the JitPack repository to your build file:

<repositories>
   <repository>
	<id>jitpack.io</id>
	<url>https://jitpack.io</url>
   </repository>
</repositories>

Add the dependency:

<dependency>
   <groupId>com.github.Flipkart</groupId>
   <artifactId>typescriptpoet</artifactId>
   <version>1.0</version>
</dependency>

Credits

Built on top of JavaPoet

License

Copyright 2015 Square, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Copyright 2018 Flipkart, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.