Skip to content

Commit 233ea22

Browse files
theetraineltigerchinoRich-Harris
authored
docs: link tsconfig sections to kit config (#14026)
* docs: link tsconfig sections to kit config * Apply suggestion from @eltigerchino * Apply suggestion from @eltigerchino --------- Co-authored-by: Tee Ming <[email protected]> Co-authored-by: Rich Harris <[email protected]>
1 parent 9c9bb7e commit 233ea22

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

documentation/docs/10-getting-started/30-project-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ This file contains your Svelte and SvelteKit [configuration](configuration).
7979

8080
### tsconfig.json
8181

82-
This file (or `jsconfig.json`, if you prefer type-checked `.js` files over `.ts` files) configures TypeScript, if you added typechecking during `npx sv create`. Since SvelteKit relies on certain configuration being set a specific way, it generates its own `.svelte-kit/tsconfig.json` file which your own config `extends`.
82+
This file (or `jsconfig.json`, if you prefer type-checked `.js` files over `.ts` files) configures TypeScript, if you added typechecking during `npx sv create`. Since SvelteKit relies on certain configuration being set a specific way, it generates its own `.svelte-kit/tsconfig.json` file which your own config `extends`. To make changes to top-level options such as `include` and `exclude`, we recommend extending the generated config; see the [`typescript.config` setting](configuration#typescript) for more details.
8383

8484
### vite.config.js
8585

documentation/docs/98-reference/54-types.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ Others are required for SvelteKit to work properly, and should also be left unto
190190
}
191191
```
192192

193+
Use the [`typescript.config` setting](configuration#typescript) in `svelte.config.js` to extend or modify the generated `tsconfig.json`.
194+
193195
## $lib
194196

195197
This is a simple alias to `src/lib`, or whatever directory is specified as [`config.kit.files.lib`](configuration#files). It allows you to access common components and utility modules without `../../../../` nonsense.

0 commit comments

Comments
 (0)