Skip to content

Commit 6a3ff28

Browse files
Update README.md
1 parent be29bb4 commit 6a3ff28

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

Vue/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,18 +13,19 @@ This project includes:
1313

1414
## Recommended IDE Setup
1515

16-
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
16+
For best TypeScript support in VS Code, see the official Vue guide: [Using Vue with TypeScript in VS Code](https://vuejs.org/guide/typescript/overview#using-vue-with-typescript).
1717

1818
## Type Support for `.vue` Imports in TS
1919

20-
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
20+
TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. For editor integration, see the official Vue guide: [Using Vue with TypeScript in VS Code](https://vuejs.org/guide/typescript/overview#using-vue-with-typescript).
2121

22-
If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/vuejs/language-tools/discussions/471) that is more performant. You can enable it by the following steps:
2322

24-
1. Disable the built-in TypeScript Extension
25-
1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette
26-
2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
27-
2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
23+
> **Note:**
24+
> To type-check your project, use:
25+
> ```sh
26+
> npm run type-check
27+
> ```
28+
> This uses `vue-tsc` to provide type checking for `.vue` files, as recommended in the [official Vue TypeScript guide](https://vuejs.org/guide/typescript/overview.html).
2829
2930
## Customize configuration
3031

0 commit comments

Comments
 (0)