Skip to content

Commit

Permalink
Add luau to configuration page
Browse files Browse the repository at this point in the history
  • Loading branch information
@Perryvw
Perryvw committed Dec 30, 2024
1 parent 69534c6 commit e78f3f9
Showing 1 changed file with 16 additions and 16 deletions.
32 changes: 16 additions & 16 deletions docs/configuration.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,22 @@ You can use our [VS Code extension](editor-support.md) or manually specify the J
}
```

| Option | Values | Description |
| -------------------------------- | -------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `buildMode` | `"default"`, `"library"` (default: `"library"`) | Use `buildMode: "library"` to build [publishable library packages](publishing-modules.md). |
| `extension` | File extension (default: `".lua"`) | Extension of emitted lua files. |
| `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. |
| `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). |
| `noImplicitSelf` | `true`, `false` (default: `false`) | If true, treats all project files as if they were prefixed with<br />`/** @noSelfInFile **/`. |
| `noHeader` | `true`, `false` (default: `false`) | Set this to true if you don't want to include our header in the output. |
| `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. |
| `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. |
| `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. |
| `luaBundle` | File path (relative to the `tsconfig.json`) | Will bundle all output lua files into a single bundle file. Requires **luaBundleEntry** to be set! |
| `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. |
| `luaPlugins` | `Array<{ name: string; import?: string }>` | List of [TypeScriptToLua plugins](api/plugins.md). |
| `tstlVerbose` | `true`, `false` (default: `false`) | Output additional logging when performing a tstl build, to help diagnose issues. |
| `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")`. |
| Option | Values | Description |
| -------------------------------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `buildMode` | `"default"`, `"library"` (default: `"library"`) | Use `buildMode: "library"` to build [publishable library packages](publishing-modules.md). |
| `extension` | File extension (default: `".lua"`) | Extension of emitted lua files. |
| `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. |
| `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). |
| `noImplicitSelf` | `true`, `false` (default: `false`) | If true, treats all project files as if they were prefixed with<br />`/** @noSelfInFile **/`. |
| `noHeader` | `true`, `false` (default: `false`) | Set this to true if you don't want to include our header in the output. |
| `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. |
| `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. |
| `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. |
| `luaBundle` | File path (relative to the `tsconfig.json`) | Will bundle all output lua files into a single bundle file. Requires **luaBundleEntry** to be set! |
| `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. |
| `luaPlugins` | `Array<{ name: string; import?: string }>` | List of [TypeScriptToLua plugins](api/plugins.md). |
| `tstlVerbose` | `true`, `false` (default: `false`) | Output additional logging when performing a tstl build, to help diagnose issues. |
| `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")`. |

## Standard options

Expand Down

0 comments on commit e78f3f9

Please sign in to comment.