Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: drop .vue shim and recommend typescript vue plugin by default #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 10, 2022
Merged

feat: drop .vue shim and recommend typescript vue plugin by default #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
33c3811
feat: drop .vue shim and recommend typescript vue plugin by default
haoqunjiang Jan 6, 2022
a03e813
docs: no need to disable typescript vue plugin manually
haoqunjiang Jan 9, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion template/base/.vscode/extensions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"recommendations": ["johnsoncodehk.volar"]
"recommendations": ["johnsoncodehk.volar", "johnsoncodehk.vscode-typescript-vue-plugin"]
}
7 changes: 0 additions & 7 deletions template/config/typescript/env.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1 @@
/// <reference types="vite/client" />

declare module '*.vue' {
import { DefineComponent } from 'vue'
// eslint-disable-next-line
const component: DefineComponent<{}, {}, any>
export default component
}
23 changes: 15 additions & 8 deletions utils/generateReadme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,20 @@ import fs from 'fs'

import getCommand from './getCommand.js'

const sfcTypeSupportDoc =
'\n' +
'## Type Support for `.vue` Imports in TS\n' +
'\n' +
"Since TypeScript cannot handle type information for `.vue` imports, they are shimmed to be a generic Vue component type by default. In most cases this is fine if you don't really care about component prop types outside of templates.\n" +
'\n' +
'However, if you wish to get actual prop types in `.vue` imports (for example to get props validation when using manual `h(...)` calls), you can run `Volar: Switch TS Plugin on/off` from VSCode command palette.\n'
const sfcTypeSupportDoc = [
'',
'## Type Support for `.vue` Imports in TS',
'',
'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=johnsoncodehk.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.',
'',
"If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471) that is more performant. You can enable it by the following steps:",
'',
'1. Disable the built-in TypeScript Extension',
" 1) Run `Extensions: Show Built-in Extensions` from VSCode's command palette",
' 2) Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`',
'2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.',
''
].join('\n')

export default function generateReadme({
projectName,
Expand All @@ -23,7 +30,7 @@ This template should help get you started developing with Vue 3 in Vite.

## Recommended IDE Setup

[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur).
[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=johnsoncodehk.vscode-typescript-vue-plugin).
${needsTypeScript ? sfcTypeSupportDoc : ''}
## Customize configuration

Expand Down