Skip to content

Mentioned json schema for tsconfig.json #69

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 5 commits into from
Aug 18, 2021
Merged

Mentioned json schema for tsconfig.json #69

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4e1d010
Mentioned json schema for tsconfig.json
Toliak Aug 17, 2021
7ee6ce5
Mentioned VS Code extension and schema
Toliak Aug 18, 2021
9bd0716
Add "optional" (json schema) in the comment
Toliak Aug 18, 2021
49a398a
Update docs/configuration.md
lolleko Aug 18, 2021
8f5aca0
Applied prettier
Toliak Aug 18, 2021
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
9 changes: 8 additions & 1 deletion docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,17 @@ TypeScriptToLua uses the same configuration file as the vanilla TypeScript compi

To customize transpilation behavior we add a new group of options to the `tsconfig.json` file. All of these options should be placed in a `tstl` object.

You can use our [VS Code extension](editor-support.md) or manually specify the JSON schema to receive autocompletion and hints for the configuration file.

```json title=tsconfig.json
{
// Optional: Schema file for hints and validation
"$schema": "https://raw.githubusercontent.com/TypeScriptToLua/vscode-typescript-to-lua/master/tsconfig-schema.json",

// ... tsconfig options

"tstl": {
// custom options
// Custom options
}
}
```
Expand Down