https://github.com/ts-defold/tstl-export-as-global
TypeScriptToLua plugin that transforms exports into globals
https://github.com/ts-defold/tstl-export-as-global
lua typescript
Last synced: about 1 year ago
JSON representation
TypeScriptToLua plugin that transforms exports into globals
- Host: GitHub
- URL: https://github.com/ts-defold/tstl-export-as-global
- Owner: ts-defold
- License: mit
- Created: 2020-10-17T12:35:57.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-01-07T01:26:11.000Z (over 2 years ago)
- Last Synced: 2025-05-01T15:44:49.820Z (about 1 year ago)
- Topics: lua, typescript
- Language: TypeScript
- Homepage: https://ts-defold.dev
- Size: 586 KB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tstl-export-as-global-plugin
> TypeScriptToLua plugin that transforms exports into globals
## Config
```json
"tstl": {
"luaPlugins": [
{
"name": "@ts-defold/tstl-export-as-global",
"match": ".*script.ts$",
"globals": {
"functions": [ "init", "on_input", "on_message", "on_reload", "update", "final"]
}
}
]
}
```
The config accpets some additional arguments that are required to make this plugin work.
- `match`: regex pattern of file names to match to apply export transformations to
- `globals`: object that defines what to match to apply export transformations to
- `functions`: array of names to match for export functions to expose as global
- `...`: PR welcome for matching constans, variables, etc if you need support.
## Features
Transform this TypeScript (with config values from above):
```ts
function no_export() {
"not-exported";
}
export function init() {
no_export();
"init";
}
export function update(dt: number) {
const val = dt * 100;
val * val;
}
export function exported() {
"exported";
}
```
To this lua:
```lua
--[[ Generated with https://github.com/TypeScriptToLua/TypeScriptToLua ]]
local ____exports = {}
local function no_export(self)
local ____ = "not-exported"
end
function ____exports.init(self)
no_export(nil)
local ____ = "init"
end
function ____exports.update(self, dt)
local val = dt * 100
local ____ = val * val
end
function ____exports.exported(self)
local ____ = "exported"
end
init = ____exports.init
update = ____exports.update
```
Any function marked for export is now exposed to the global (file) scope. This plugin was created to expose functions to file scope for the Defold runtime where the runtime expects to call these functions.