Skip to content

Latest commit

 

History

History
60 lines (42 loc) · 1.95 KB

README.md

File metadata and controls

60 lines (42 loc) · 1.95 KB

official JetBrains project GitHub license

What is Katod

Katod is a converter of TypeScript definition files to Kotlin declarations. It's a fork of Dukat project, an officially supported by Jetbrains tool for the same purposes.

As of now there now there's absolutely no difference between dukat and katod, feel free to use whatever you like more.

Katod requires JRE 1.6+ to run. It generates Kotlin files that are compatible with Kotlin 1.1+ (generated declarations are tested against latest stable compiler version)

How to install

The simplest way to use is install the latest version form npm:

npm install -g katod

Usage

katod [<options>] <d.ts files>

where possible options include:

    -p  <qualifiedPackageName>      package name for the generated file (by default filename.d.ts renamed to filename.d.kt)
    -m  String                      use this value as @file:JsModule annotation value whenever such annotation occurs
    -d  <path>                      destination directory for files with converted declarations (by default declarations are generated in current directory)
    -v, -version                    print version

How to setup and build

  1. clone this project
# on Windows-based platforms set following: `git config core.autocrlf true`   
git clone <this project url>
  1. build
./gradlew build
  1. (optional) Run unit tests
./gradlew test -Pdukat.test.failure.always

see CHANGELOG

Useful links