开发 Vue 3 项目时,VS Code 的插件选择直接影响到编码效率、错误排查速度和团队规范落地。本文整理了一套经过实战验证的插件组合,并针对 Vue 3 的 <script setup>、TypeScript、路径别名和保存时自动格式化等场景,补充了关键配置方法。
核心语言支持:Vue - Official
Vue - Official 是 Vue 3 的官方语言插件,原名 Volar,负责提供模板语法高亮、类型检查、以及对 <script setup> 和 TypeScript 的智能提示。如果你之前为 Vue 2 安装过 Vetur,需要先卸载 Vetur,否则两个插件会同时接管 Vue 文件并产生冲突。Vue 3 项目只保留 Vue - Official 即可。
代码片段:Vue 3 Snippets
Vue 3 Snippets 用来减少重复的模板代码。比如输入 v3setup 可以快速生成完整的 <script setup> 组件结构;输入 v3ref 快速生成 ref 响应式变量;输入 v3onMounted 生成挂载后的生命周期调用。这些简短缩写适合在创建组件、添加状态声明或生命周期钩子时使用。
自动导入:Auto Import
使用 ref、computed、watch 这类 Vue 3 API 时,Auto Import 会自动查找并补全 import 语句。它也能识别项目中的自定义组件和模块,减少手动引入带来的遗漏。配合 ESLint 使用,还能清理未使用的 import,让源码更干净。
路径补全与 @ 别名跳转
Path Intellisense 可以在输入 ./ 或 @/ 时给出手动输入无法保证的路径提示。默认情况下它无法识别 Vue 项目的 @ 别名,需要在 VS Code 的 settings.json 中加入映射:
- {
- "path-intellisense.mappings": {
- "@": "${workspaceFolder}/src"
- }
- }
复制代码
这一步让 @/components/xxx 这类导入路径也能获得补全。
另外还有一个与路径相关的跳转插件,专门用于解决 @/components/xxx 这类别名路径无法通过 Ctrl+点击 跳转到源文件的问题。安装后需结合项目的 jsconfig.json 或 tsconfig.json 中配置的 paths 来使用,否则 VS Code 无法知道别名对应的真实目录。注意,这个插件在扩展市场中直接搜索“别名路径跳转”即可,部分文章给出的扩展 ID 并不准确,应以搜索结果为准。
代码格式化:Prettier
Prettier 负责统一 JavaScript、Vue、CSS 等文件的格式。推荐的做法是开启保存时自动格式化,并设置默认格式化器为 Prettier。下面是一份 Vue 3 项目常用的配置:
- {
- "editor.formatOnSave": true,
- "editor.defaultFormatter": "esbenp.prettier-vscode",
- "prettier.singleQuote": true,
- "prettier.semi": false
- }
复制代码
上述配置意味着保存文件时自动格式化,字符串统一使用单引号,并且语句末尾不写分号。如果你的团队有不同风格,由 Prettier 接管后,只需要改这一个文件就能同步到所有人。
行内错误显示:Error Lens
Error Lens 会把代码中的错误和警告直接渲染在对应行内,不必再把鼠标悬停在波浪线上才能看到具体内容。在调试 TypeScript 类型错误、模板表达式问题或 ESLint 提示时,这种即时可见的反馈能显著提升定位速度。
代码规范检查:ESLint
ESLint 插件用于实时检测 JavaScript/TypeScript/Vue 文件中的语法和风格问题。配合 Vue 官方的 eslint-plugin-vue,还能检查模板中的常见问题,例如 v-for 缺少 key。为了在保存时自动修复可修复的问题,建议在 settings.json 中单独配置:
- {
- "editor.codeActionsOnSave": {
- "source.fixAll.eslint": true
- },
- "eslint.validate": ["javascript", "typescript", "vue"]
- }
复制代码
这样 ESLint 的修复动作会在保存时触发,而不是覆盖掉 Prettier 的格式化职责。
文件图标与组件跳转
Material Icon Theme 可以为不同类型文件提供不同图标,在资源管理器中快速分辨 .vue、.ts、.css 等文件。Vue Peek 则允许在模板中按住 Ctrl 并点击组件名,直接跳转到该组件的定义文件,对于组件嵌套较深的项目非常实用。
团队统一环境配置
为了让团队每个人的 VS Code 行为一致,建议在项目根目录创建 .vscode/settings.json 来存放共享配置。一个典型的 Vue 3 项目可配置为:
- {
- "editor.formatOnSave": true,
- "editor.codeActionsOnSave": {
- "source.fixAll.eslint": true
- },
- "eslint.validate": ["javascript", "typescript", "vue"]
- }
复制代码
这样新成员克隆代码后,打开项目即可自动应用相同的编辑、格式化与 Lint 规则,避免因本地配置差异导致无意义的 git 冲突。
命令行批量安装
如果需要在全新环境中快速安装上述插件,可以打开 VS Code 的终端,执行下面的命令批量安装(需确保 code 命令已加入 PATH):
- code --install-extension Vue.volar
- code --install-extension hollowtree.vue-snippets
- code --install-extension steoates.autoimport
- code --install-extension christian-kohler.path-intellisense
- code --install-extension esbenp.prettier-vscode
- code --install-extension usernamehw.errorlens
- code --install-extension dbaeumer.vscode-eslint
- code --install-extension PKief.material-icon-theme
- code --install-extension dsznajder.vue-peek
复制代码
注意安装命令统一使用 --install-extension,并且每个扩展名需要对应正确的 publisher 与插件名。若在扩展市场搜索不到某个插件,应直接在 UI 界面搜索并按实际安装的扩展 ID 为准。
这些插件覆盖了 Vue 3 开发的完整链路:语言支持、模板片段、自动导入、路径补全、格式化、Lint、错误显示、图标识别和组件跳转。配合 .vscode 目录下的共享配置,能够减少很多重复操作,也更方便团队维护统一的编码风格。 |