Skip to content

Commit ec9afe7

Browse files
Toliaklolleko
andauthored
Mentioned json schema for tsconfig.json (#69)
* Mentioned json schema for tsconfig.json See TypeScriptToLua/vscode-typescript-to-lua#4 * Mentioned VS Code extension and schema Co-authored-by: Lorenz Junglas <lolleko@users.noreply.github.com> * Add "optional" (json schema) in the comment Co-authored-by: Lorenz Junglas <lolleko@users.noreply.github.com> * Update docs/configuration.md * Applied prettier Co-authored-by: Lorenz Junglas <lolleko@users.noreply.github.com>
1 parent 2910552 commit ec9afe7

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/configuration.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,17 @@ TypeScriptToLua uses the same configuration file as the vanilla TypeScript compi
88

99
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.
1010

11+
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.
12+
1113
```json title=tsconfig.json
1214
{
15+
// Optional: Schema file for hints and validation
16+
"$schema": "https://raw.githubusercontent.com/TypeScriptToLua/vscode-typescript-to-lua/master/tsconfig-schema.json",
17+
18+
// ... tsconfig options
19+
1320
"tstl": {
14-
// custom options
21+
// Custom options
1522
}
1623
}
1724
```

0 commit comments

Comments
 (0)