webstrom 快速创建typescript 语法检测的Vue3项目
若您想为您的Vue 3项目添加TypeScript支持,您需要进行以下步骤:
- 安装
typescript
和@vitejs/plugin-vue
作为开发依赖项:
npm install --save-dev typescript @vitejs/plugin-vue
- 创建一个
tsconfig.json
文件,以配置TypeScript。您可以使用以下命令生成一个基本的tsconfig.json
文件:
npx tsc --init
然后,修改 tsconfig.json
文件,确保它包含以下配置:
{
"compilerOptions": {
"target": "esnext",
"module": "esnext",
"moduleResolution": "node",
"jsx": "preserve",
"strict": true,
"esModuleInterop": true,
"skipLibCheck": true,
"forceConsistentCasingInFileNames": true,
"moduleResolution": "node",
"resolveJsonModule": true,
"isolatedModules": true,
"noEmit": true,
"noImplicitAny": true,
"types": ["vite/client", "vue"],
"allowSyntheticDefaultImports": true
},
"include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"],
"exclude": ["node_modules"]
}
- 修改你的
tsvue-playground
项目的package.json
文件,确保@vitejs/plugin-vue
插件被配置为使用 TypeScript:
{
// ... 省略其它配置
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview"
},
"dependencies": {
"vue": "^3.3.11"
},
"devDependencies": {
"@vitejs/plugin-vue": "^4.5.2",
"typescript": "^4.5.4",
"vite": "^5.0.10"
}
}
-
如果您已经在
src
目录下有.js
文件,将它们重命名为.ts
文件。 -
如果您使用Vue文件(
.vue
),确保它们使用了<script lang="ts">
来表示TypeScript。例如:
<script lang="ts">
import { defineComponent } from 'vue';
export default defineComponent({
// 组件定义
});
</script>
完成上述步骤后,您的Vue 3项目就应该支持TypeScript了。在运行 npm run dev
时,Vite 将会检查您的 TypeScript 代码,并根据配置进行类型检查。
完整package.json
//package.json
{
"name": "tsvue-playground",
"version": "0.0.0",
"private": true,
"type": "module",
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview"
},
"dependencies": {
"vue": "^3.3.11"
},
"devDependencies": {
"@vitejs/plugin-vue": "^4.5.2",
"typescript": "^5.3.3",
"vite": "^5.0.10"
}
}