Skip to content

Commit e78f3f9

Browse files
PerryvwPerryvw
committed
Add luau to configuration page
1 parent 69534c6 commit e78f3f9

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

Diff for: ‎docs/configuration.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -23,22 +23,22 @@ You can use our [VS Code extension](editor-support.md) or manually specify the J
2323
}
2424
```
2525

26-
| Option | Values | Description |
27-
| -------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28-
| `buildMode` | `"default"`, `"library"` (default: `"library"`) | Use `buildMode: "library"` to build [publishable library packages](publishing-modules.md). |
29-
| `extension` | File extension (default: `".lua"`) | Extension of emitted lua files. |
30-
| `luaTarget` | `"JIT"`, `"5.4"`, `"5.3"`, `"5.2"`, `"5.1"`, `"universal"`, `"5.0"` (default: `"universal"`) | Specifies the Lua version you want to generate code for. Choosing `universal` makes TypeScriptToLua generate code compatible with all supported Lua targets, except for Lua 5.0, which features an unique syntax not compatible with that of the other targets. |
31-
| `noImplicitGlobalVariables` | `true`, `false` (default: `false`) | If true, always makes root level function and variable declarations local, even if not in a module (would be global in TypeScript). |
32-
| `noImplicitSelf` | `true`, `false` (default: `false`) | If true, treats all project files as if they were prefixed with<br />`/** @noSelfInFile **/`. |
33-
| `noHeader` | `true`, `false` (default: `false`) | Set this to true if you don't want to include our header in the output. |
34-
| `lua51AllowTryCatchInAsyncAwait` | `true`, `false` (default: `false`) | Disable warning diagnostic about try/catch inside `async` functions for Lua 5.1, in case you are using a modified 5.1 environment that can handle this. |
35-
| `luaLibImport` | `"inline"`, `"require"`, `"require-minimal"`, `"none"` (default: `"require"`) | We polyfill certain JavaScript features with Lua functions, this option specifies how these functions are imported into the Lua output. `"inline"`: Inline used functions in code; `"require"`: Require full lualib bundle if used in file. `"require-minimal"`: Require a partial lualib bundle containing only the functions used by your code. `"none"`: Never require/inline any lualib features. |
36-
| `sourceMapTraceback` | `true`, `false` (default: `false`) | Overrides Lua's `debug.traceback` to apply sourcemaps to Lua stacktraces. This will make error messages point to your original TypeScript code instead of the generated Lua. |
37-
| `luaBundle` | File path (relative to the `tsconfig.json`) | Will bundle all output lua files into a single bundle file. Requires **luaBundleEntry** to be set! |
38-
| `luaBundleEntry` | File path (relative to the `tsconfig.json`) | This should be the name/path of the TS file in your project that will serve as entry point to the bundled code. |
39-
| `luaPlugins` | `Array<{ name: string; import?: string }>` | List of [TypeScriptToLua plugins](api/plugins.md). |
40-
| `tstlVerbose` | `true`, `false` (default: `false`) | Output additional logging when performing a tstl build, to help diagnose issues. |
41-
| `noResolvePaths` | `Array<string>` | An array of require paths that will **NOT** be resolved. For example `["require1", "sub.require2"]` will stop tstl from trying to resolve Lua sources for `require("require1")` and `require("sub.require2")`. |
26+
| Option | Values | Description |
27+
| -------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
28+
| `buildMode` | `"default"`, `"library"` (default: `"library"`) | Use `buildMode: "library"` to build [publishable library packages](publishing-modules.md). |
29+
| `extension` | File extension (default: `".lua"`) | Extension of emitted lua files. |
30+
| `luaTarget` | `"JIT"`, `"5.4"`, `"5.3"`, `"5.2"`, `"5.1"`, `"universal"`, `"5.0"`, `"Luau"` (default: `"universal"`) | Specifies the Lua version you want to generate code for. Choosing `universal` makes TypeScriptToLua generate code compatible with all supported Lua targets, except for Lua 5.0, which features an unique syntax not compatible with that of the other targets. |
31+
| `noImplicitGlobalVariables` | `true`, `false` (default: `false`) | If true, always makes root level function and variable declarations local, even if not in a module (would be global in TypeScript). |
32+
| `noImplicitSelf` | `true`, `false` (default: `false`) | If true, treats all project files as if they were prefixed with<br />`/** @noSelfInFile **/`. |
33+
| `noHeader` | `true`, `false` (default: `false`) | Set this to true if you don't want to include our header in the output. |
34+
| `lua51AllowTryCatchInAsyncAwait` | `true`, `false` (default: `false`) | Disable warning diagnostic about try/catch inside `async` functions for Lua 5.1, in case you are using a modified 5.1 environment that can handle this. |
35+
| `luaLibImport` | `"inline"`, `"require"`, `"require-minimal"`, `"none"` (default: `"require"`) | We polyfill certain JavaScript features with Lua functions, this option specifies how these functions are imported into the Lua output. `"inline"`: Inline used functions in code; `"require"`: Require full lualib bundle if used in file. `"require-minimal"`: Require a partial lualib bundle containing only the functions used by your code. `"none"`: Never require/inline any lualib features. |
36+
| `sourceMapTraceback` | `true`, `false` (default: `false`) | Overrides Lua's `debug.traceback` to apply sourcemaps to Lua stacktraces. This will make error messages point to your original TypeScript code instead of the generated Lua. |
37+
| `luaBundle` | File path (relative to the `tsconfig.json`) | Will bundle all output lua files into a single bundle file. Requires **luaBundleEntry** to be set! |
38+
| `luaBundleEntry` | File path (relative to the `tsconfig.json`) | This should be the name/path of the TS file in your project that will serve as entry point to the bundled code. |
39+
| `luaPlugins` | `Array<{ name: string; import?: string }>` | List of [TypeScriptToLua plugins](api/plugins.md). |
40+
| `tstlVerbose` | `true`, `false` (default: `false`) | Output additional logging when performing a tstl build, to help diagnose issues. |
41+
| `noResolvePaths` | `Array<string>` | An array of require paths that will **NOT** be resolved. For example `["require1", "sub.require2"]` will stop tstl from trying to resolve Lua sources for `require("require1")` and `require("sub.require2")`. |
4242

4343
## Standard options
4444

0 commit comments

Comments
 (0)