Skip to content

fix: grammar + more thorough explanation #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 14, 2025
Merged

fix: grammar + more thorough explanation #201

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13316b8
Update configuration.md
Zamiell Aug 14, 2025
c9a8aa3
Update docs/configuration.md
Zamiell Aug 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,10 @@ Most of the standard [TypeScript options](https://www.typescriptlang.org/docs/ha

Some options do not apply to TypeScriptToLua and are ignored:

- `outFile` - use `luaBundle` instead.
- `importHelpers`, `noEmitHelpers` - use `luaLibImport` instead.
- `target`, `module` - it's only effect is limiting some features, so prefer to set it to `esnext`. If TypeScript requires you to specify different `module` type because you want to bundle your declarations with `outFile`, consider using [API Extractor](https://api-extractor.com/) instead.
- `outFile` - Use `luaBundle` instead.
- `importHelpers` / `noEmitHelpers` - Use `luaLibImport` instead.
- `target` - In normal TypeScript projects, this represents the JavaScript compilation target. TSTL users should always set this to `ESNext`, which allows your source code to use every [ECMAScript feature](https://github.com/sudheerj/ECMAScript-features).
- `module` - In normal TypeScript projects, this specifies the module system. TSTL users should omit this option, since it will default to `ES2015`. If TypeScript forces you to specify `module` because you want to bundle your declarations with `outFile`, consider using [API Extractor](https://api-extractor.com/) instead.

## Transformers

Expand Down