https://github.com/thinknathan/tsd-ext-type-gen

TypeScript definitions generator that parses script APIs from Defold extensions
https://github.com/thinknathan/tsd-ext-type-gen

defold defold-game-engine gamedev ts-defold typescript typescript-definitions

Last synced: 2 months ago
JSON representation

TypeScript definitions generator that parses script APIs from Defold extensions

• Host: GitHub
• URL: https://github.com/thinknathan/tsd-ext-type-gen
• Owner: thinknathan
• License: mit
• Created: 2024-01-30T04:32:01.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-10-01T02:48:50.000Z (3 months ago)
• Last Synced: 2024-10-04T22:08:16.230Z (3 months ago)
• Topics: defold, defold-game-engine, gamedev, ts-defold, typescript, typescript-definitions
• Language: JavaScript
• Homepage:
• Size: 588 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# TS Definitions Generator for TypeScript-Defold

[![CI](https://github.com/thinknathan/tsd-ext-type-gen/actions/workflows/ci.yml/badge.svg)](https://github.com/thinknathan/tsd-ext-type-gen/actions/workflows/ci.yml) ![GitHub License](https://img.shields.io/github/license/thinknathan/tsd-ext-type-gen) 

TypeScript definitions generator that parses script APIs from Defold extensions. Made for use with [TypeScript + Defold](https://ts-defold.dev/).

This tool searches through dependencies in your Defold project file, then attempts to find `script_api` files, and parse them to create TypeScript definitions.

## Installation

```bash

yarn add tsd-ext-type-gen -D

# or

npm install tsd-ext-type-gen --save-dev

```

## Usage

`npx xtgen`

- `-p` path to your `game.project` (default `./app/game.project`)

- `-o` path to an output folder (default `./@types`)

## Background

Started as a fork of @thejustinwalsh's [type-gen](https://github.com/ts-defold/type-gen), now with significant rewrites.



  TypeScript :heart: Defold