Kotlin TypeScript Definitions Generator Gradle Plugin

Related documents

• Open Practices
• Rules of Behavior
• Thanks and Acknowledgements
• Disclaimer
• Contribution Notice
• Code of Conduct

Overview

A gradle plugin for ts-generator with additional enhancements including:

• Support for JSON Jackson Annotations when converting to TypeScript
• Configure how you would like to import the TypeScript definitions in your project (default, as exports or declare global)
• Option for creating an object representation of TypeScript string union types (what Kotlin enums are converted to)

How to Use

The following configuration options from ts-generator are exposed:

• typeMappings (Map<String, String>)
• imports (List<String>)
• intTypeName (String)
• voidType (VoidType)

Additionally, these are exposed:

• manualClasses (List<string>): Manually select classes. Use their fully qualified names.
• outputPath (Path): Where to write output typescript declaration file
• typescriptImportMode (TypescriptImportMode): How the types should be imported
• typescriptEnumType (TypescriptEnumType): How typescript enums should be handled
• classPath (FileCollection): Usually layout.files(project.sourceSets.main.get().runtimeClasspath)

A special export annotation (gov.cdc.prime.tsGenerator.TsExport) can be used to select classes that you want to be exported. In situations where your classes are generated dynamically, you can use the manualClasses configuration option to manually select them.

Example configuration in build.gradle.kts:

typescriptGenerator.apply {
    outputPath.set(project.projectDir.toPath().resolve("../frontend/src/typings/api-codegen.ts"))
    classPath.set(layout.files(project.sourceSets.main.get().runtimeClasspath))
    manualClasses.set(
        listOf(
            "foo.bar.CodeGeneratedClassA",
            "foo.bar.CodeGeneratedClassB"
        )
    )
}

// Called during "classes" stage of gradle lifecycle. See: https://docs.gradle.org/current/userguide/java_plugin.html#lifecycle_tasks
tasks.classes {
    finalizedBy("generateTypescriptDefinitions")
}

Example annotation usage:

import gov.cdc.prime.tsGenerator.TsExport

@TsExport
class Foo {
  bar: String
}

Public Domain Standard Notice

This repository constitutes a work of the United States Government and is not subject to domestic copyright protection under 17 USC § 105. This repository is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication. All contributions to this repository will be released under the CC0 dedication. By submitting a pull request you are agreeing to comply with this waiver of copyright interest.

License Standard Notice

The repository utilizes code licensed under the terms of the Apache Software License and therefore is licensed under ASL v2 or later.

This source code in this repository is free: you can redistribute it and/or modify it under the terms of the Apache Software License version 2, or (at your option) any later version.

This source code in this repository is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License for more details.

You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/LICENSE-2.0.html

The source code forked from other open source projects will inherit its license.

Privacy Standard Notice

This repository contains only non-sensitive, publicly available data and information. All material and community participation is covered by the Disclaimer and Code of Conduct. For more information about CDC's privacy policy, please visit http://www.cdc.gov/other/privacy.html.

Contributing Standard Notice

Anyone is encouraged to contribute to the repository by forking and submitting a pull request. (If you are new to GitHub, you might start with a basic tutorial.) By contributing to this project, you grant a world-wide, royalty-free, perpetual, irrevocable, non-exclusive, transferable license to all users under the terms of the Apache Software License v2 or later.

All comments, messages, pull requests, and other submissions received through CDC including this GitHub page may be subject to applicable federal law, including but not limited to the Federal Records Act, and may be archived. Learn more at http://www.cdc.gov/other/privacy.html.

Records Management Standard Notice

This repository is not a source of government records, but is a copy to increase collaboration and collaborative potential. All government records will be published through the CDC web site.

Additional Standard Notices

Please refer to CDC's Template Repository for more information about contributing to this repository, public domain notices and disclaimers, and code of conduct.