docs: add warning about overriding tsconfig types (#14861)

appsforartists · patak-cat · sapphi-red · web-flow · commit 367cec1d8929 · 2025-02-13T12:55:04.000+09:00
Co-authored-by: patak &lt;583075+patak-dev@users.noreply.github.com&gt;
Co-authored-by: sapphi-red &lt;49056869+sapphi-red@users.noreply.github.com&gt;
diff --git a/docs/guide/features.md b/docs/guide/features.md
@@ -129,12 +129,18 @@ Alternatively, you can add `vite/client` to `compilerOptions.types` inside `tsco
 ```json [tsconfig.json]
 {
   "compilerOptions": {
-    "types": ["vite/client"]
+    "types": ["vite/client", "some-other-global-lib"]
   }
 }
 ```
 
-This will provide the following type shims:
+::: warning
+
+If [`compilerOptions.types`](https://www.typescriptlang.org/tsconfig#types) is specified, only these packages will be included in the global scope (instead of all visible ”@types” packages).
+
+:::
+
+`vite/client` provides the following type shims:
 
 - Asset imports (e.g. importing an `.svg` file)
 - Types for the Vite-injected [constant variables](./env-and-mode#env-variables) on `import.meta.env`

Original file line number	Diff line number	Diff line change
@@ -129,12 +129,18 @@ Alternatively, you can add `vite/client` to `compilerOptions.types` inside `tsco
`129`	`129`	```json [tsconfig.json]
`130`	`130`	`{`
`131`	`131`	`"compilerOptions": {`
`132`		`- "types": ["vite/client"]`
	`132`	`+ "types": ["vite/client", "some-other-global-lib"]`
`133`	`133`	`}`
`134`	`134`	`}`
`135`	`135`	```
`136`	`136`
`137`		`-This will provide the following type shims:`
	`137`	`+::: warning`
	`138`	`+`
	`139`	+If [`compilerOptions.types`](https://www.typescriptlang.org/tsconfig#types) is specified, only these packages will be included in the global scope (instead of all visible ”@types” packages).
	`140`	`+`
	`141`	`+:::`
	`142`	`+`
	`143`	+`vite/client` provides the following type shims:
`138`	`144`
`139`	`145`	- Asset imports (e.g. importing an `.svg` file)
`140`	`146`	- Types for the Vite-injected [constant variables](./env-and-mode#env-variables) on `import.meta.env`