gmod-typescript

gmod-typescript copied to clipboard

Typescript Declarations for Gmod

Intended for use with https://typescripttolua.github.io

What's new

• Updated to use new Facepunch wiki as source
• Updated to latest tstl version (requires 0.38.0 or higher)
• Types can now be augmented using data based transformers
  • If you want to help improve the declarations make a PR for src/transformer/modfications.json

TODO

• create template/example project

Usage

1. npm install gmod-types
2. modify the tsconfig, add the declaration files to your types or typeRoots
3. use "skipLibCheck": true, in your tsconfig.json if you get duplicate identifier errors.

Development

1. Clone
2. npm install
3. npm run build to build the project
4. npm run generate to generate declarations

Program structure

• Scrapper
  • Fetch wiki data
  • Conversion of wiki xml to Wiki Objects
• Transformer
  • Transforms extracted wiki objects to Typed Objects
• Printer
  • Print the typed objects to out/declarations.ts