A generic TypeScript to Lua transpiler. Write your code in TypeScript and publish Lua!
More detailed documentation and info on writing declarations can be found on the wiki.
Install
npm install -g typescript-to-lua
Compile Files
tstl path/to/file.ts path/to/other-file.ts
Compile Projects
tstl -p path/to/tsconfig.json
Options
tstl [options] [files...]
In addition to the options listed below you can also pass options for the
typescript compiler (For a list of options use tsc -h).
NOTES:
- The tsc options might have no effect.
- Options in tsconfig.json are prioritized.
Options:
--help Show help [boolean]
--version Show version number [boolean]
--lt, --luaTarget Specify Lua target version.
[string] [choices: "JIT", "5.1", "5.2", "5.3"] [default: "JIT"]
--lld, --luaLibDir Specify typescript_lualib.lua location relative to outDir.
[string] [default: "./"]
--ah, --addHeader Specify if a header will be added to compiled files.
[boolean] [default: true]
Examples:
tstl path/to/file.ts [...] Compile files
tstl -p path/to/tsconfig.json Compile project
Example tsconfig.json
{
"compilerOptions": {
"noImplicitAny" : true,
"noImplicitThis" : true,
"alwaysStrict" : true,
"strictNullChecks": true,
"luaTarget": "JIT"
}
}
This compiler works great in combination with the Sublime Text Typescript plugin (available through the package manager as TypeScript).
You can simply open your typescript project assuming a valid tsconfig.json file is present. The default TypeScript plugin will provide all functionality of a regular TypeScript project.
To add the option to build with the Lua transpiler instead of the regular typescript compiler, go to Tools > Build System > New Build System.... In the new sublime-build file that opens, enter the following (adjust path to tstl if not installed globally):
{
"cmd": ["tstl", "-p", "$file"],
"shell": true
}
Save this in your Sublime settings as a TypeScriptToLua.sublime-build. You can now select the TypeScriptToLua build system in Tools > Build System to build using the normal hotkey (ctrl+B), or if you have multiple TypeScript projects open, you can choose your compiler before building by pressing ctrl+shift+B.