Skip to content

Commit ba8b7af

Browse files
authored
feat(create-app): improve client types (#3214)
1 parent d852731 commit ba8b7af

File tree

13 files changed

+13
-7
lines changed

13 files changed

+13
-7
lines changed

docs/guide/features.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,13 @@ Note that because `esbuild` only performs transpilation without type information
3838

3939
### Client Types
4040

41-
Vite's default types are for its Node.js API. To shim the environment of client side code in a Vite application, add `vite/client` to `compilerOptions.types` of your `tsconfig`:
41+
Vite's default types are for its Node.js API. To shim the environment of client side code in a Vite application, add a `d.ts` declaration file:
42+
43+
```typescript
44+
/// <reference types="vite/client" />
45+
```
46+
47+
Also, you can add `vite/client` to `compilerOptions.types` of your `tsconfig`:
4248

4349
```json
4450
{
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/// <reference types="vite/client" />

packages/create-app/template-lit-element-ts/tsconfig.json

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"compilerOptions": {
33
"module": "esnext",
44
"lib": ["es2017", "dom", "dom.iterable"],
5-
"types": ["vite/client"],
65
"declaration": true,
76
"emitDeclarationOnly": true,
87
"outDir": "./types",
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/// <reference types="vite/client" />

packages/create-app/template-preact-ts/tsconfig.json

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"compilerOptions": {
33
"target": "ESNext",
44
"lib": ["DOM", "DOM.Iterable", "ESNext"],
5-
"types": ["vite/client"],
65
"allowJs": false,
76
"skipLibCheck": false,
87
"esModuleInterop": false,
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/// <reference types="vite/client" />

packages/create-app/template-react-ts/tsconfig.json

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
"compilerOptions": {
33
"target": "ESNext",
44
"lib": ["DOM", "DOM.Iterable", "ESNext"],
5-
"types": ["vite/client"],
65
"allowJs": false,
76
"skipLibCheck": false,
87
"esModuleInterop": false,
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/// <reference types="vite/client" />

packages/create-app/template-vanilla-ts/tsconfig.json

-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
"sourceMap": true,
99
"resolveJsonModule": true,
1010
"esModuleInterop": true,
11-
"types": ["vite/client"],
1211
"noEmit": true,
1312
"noUnusedLocals": true,
1413
"noUnusedParameters": true,
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/// <reference types="vite/client" />

packages/create-app/template-vue-ts/tsconfig.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
"sourceMap": true,
99
"resolveJsonModule": true,
1010
"esModuleInterop": true,
11-
"lib": ["esnext", "dom"],
12-
"types": ["vite/client"]
11+
"lib": ["esnext", "dom"]
1312
},
1413
"include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
1514
}

0 commit comments

Comments
 (0)