From 4e1d010996ac077dd2b1430ff02197ed15a50f1a Mon Sep 17 00:00:00 2001 From: Toliak Date: Tue, 17 Aug 2021 22:28:15 +0300 Subject: [PATCH 1/5] Mentioned json schema for tsconfig.json See https://github.com/TypeScriptToLua/vscode-typescript-to-lua/issues/4 --- docs/configuration.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index 94973fb0..c9025f43 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -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. +Optionally, you can specify the json schema in the `$schema` property to recieve custom options hints from the IDE. + ```json title=tsconfig.json { + // 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 } } ``` From 7ee6ce5568cbd0559fd86168ea79fe46214bba28 Mon Sep 17 00:00:00 2001 From: Toliak Date: Wed, 18 Aug 2021 10:14:56 +0300 Subject: [PATCH 2/5] Mentioned VS Code extension and schema Co-authored-by: Lorenz Junglas --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index c9025f43..61c141d3 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -8,7 +8,7 @@ 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. -Optionally, you can specify the json schema in the `$schema` property to recieve custom options hints from the IDE. +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 { From 9bd07160c11bebac50b0dd41ba43fbf901a002ae Mon Sep 17 00:00:00 2001 From: Toliak Date: Wed, 18 Aug 2021 10:15:47 +0300 Subject: [PATCH 3/5] Add "optional" (json schema) in the comment Co-authored-by: Lorenz Junglas --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index 61c141d3..dffa673a 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -12,7 +12,7 @@ You can use our [VS Code extension](editor-support.md) or manually specify the j ```json title=tsconfig.json { - // Schema file for hints and validation + // Optional: Schema file for hints and validation "$schema": "https://raw.githubusercontent.com/TypeScriptToLua/vscode-typescript-to-lua/master/tsconfig-schema.json", // ... tsconfig options From 49a398a28ba7d9bfd211cf0e5ec559ae53a80143 Mon Sep 17 00:00:00 2001 From: Lorenz Junglas Date: Wed, 18 Aug 2021 10:04:09 +0200 Subject: [PATCH 4/5] Update docs/configuration.md --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index dffa673a..0c2fa4c8 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -8,7 +8,7 @@ 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. +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 { From 8f5aca0002568f0fe43ef093b1969a9704a11c69 Mon Sep 17 00:00:00 2001 From: Toliak Date: Wed, 18 Aug 2021 11:31:10 +0300 Subject: [PATCH 5/5] Applied prettier --- docs/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration.md b/docs/configuration.md index 0c2fa4c8..624e2520 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -14,7 +14,7 @@ You can use our [VS Code extension](editor-support.md) or manually specify the J { // Optional: Schema file for hints and validation "$schema": "https://raw.githubusercontent.com/TypeScriptToLua/vscode-typescript-to-lua/master/tsconfig-schema.json", - + // ... tsconfig options "tstl": {