Vue3 项目 VSCode 配置指南：settings.json 与 Prettier

Vue3 项目 VSCode 配置指南

本文介绍如何配置 VSCode 以适配 Vue3 + Vite + JavaScript/TypeScript 项目，解决格式化冲突、缩进、引号、换行等问题。

一、先确认已安装插件

打开 VSCode 扩展面板 Ctrl+Shift+X，安装以下插件：

1. Vue Language Features (Volar) → Vue3 官方必备插件
2. Prettier - Code formatter → 代码格式化核心插件

二、VSCode settings.json 配置（Vue3 专用）

打开方式

Ctrl+Shift+P → 输入 Open Settings (JSON) → 回车，替换为以下内容：

{
  // ==================== Vue3 核心格式化配置 ====================
  // 默认格式化工具 = Prettier
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  // 保存文件时自动格式化（最实用）
  "editor.formatOnSave": true,
  // 粘贴代码自动格式化
  "editor.formatOnPaste": true,
  // 选中代码可手动格式化
  "editor.formatOnSelection": true,
  // 自动修复 ESLint 错误（配合格式化）
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  // ==================== 分语言指定格式化器 ====================
  "[vue]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[html]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[css]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[scss]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[json]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  // ==================== Vue3 语法优化 ====================
  // Volar 插件格式化支持
  "vue.autoInsertParentheses": true,
  // 关闭 VSCode 自带的格式化冲突
  "javascript.format.enable": false,
  "typescript.format.enable": false,
  // 缩进统一为 2 个空格（Vue3 标准）
  "editor.tabSize": 2,
  "editor.insertSpaces": true
}

三、.prettierrc 配置文件（Vue3 团队标准）

使用方式

在您的 Vue3 项目根目录，新建一个文件，命名为 .prettierrc，复制以下内容：

{
  "printWidth": 120,
  // 一行最大字符数（Vue3 推荐）
  "tabWidth": 2,
  // 缩进 2 空格（强制标准）
  "useTabs": false,
  // 禁用 Tab，用空格缩进
  "semi": true,
  // 语句末尾加分号
  "singleQuote": true,
  // 使用单引号（Vue3 标准）
  "quoteProps": "as-needed",
  // 对象属性仅必要时加引号
  "jsxSingleQuote": true,
  // JSX 使用单引号
  "trailingComma": "es5",
  // 末尾逗号（数组/对象保留）
  "bracketSpacing": true,
  // 对象大括号内保留空格 { name: xxx }
  "bracketSameLine": false,
  // HTML 标签反尖括号单独一行（Vue 标准）
  "arrowParens": "avoid",
  // 箭头函数单参数省略括号
  "endOfLine": "lf",
  // 换行符统一为 LF（避免 Windows/Mac 冲突）
  "htmlWhitespaceSensitivity": "css"
  // HTML 空格敏感度（不破坏布局）
}

四、格式化快捷键（Vue3 一键格式化）

1. 格式化整个文件：Shift + Alt + F（Windows）/ Shift + Option + F（Mac）
2. 自动格式化：直接按 Ctrl + S 保存文件，自动格式化代码
3. 格式化选中代码：选中代码 → 按 Shift + Alt + F

五、额外优化（可选，解决 ESLint 冲突）

如果您的 Vue3 项目用了 ESLint，执行这行命令安装兼容包：

npm install eslint-config-prettier eslint-plugin-prettier -D

然后在 .eslintrc.cjs 中添加：

module.exports = {
  extends: [
    'plugin:vue/vue3-essential',
    'eslint:recommended',
    'plugin:prettier/recommended'
    // 关键：Prettier+ESLint 兼容
  ]
};

总结

1. 复制 settings.json → 配置 VSCode 格式化行为
2. 项目根目录新建 .prettierrc → 统一 Vue3 代码风格
3. 保存文件自动格式化，快捷键一键格式化
4. 完美支持 Vue3 <script setup> 语法、CSS/Scss、TS/JS