为 Vue3 + TypeScript + Vite 项目配置 Prettier代码格式化

下面是为 Vue3 + TypeScript + Vite 项目单独配置 Prettier 的详细步骤(不包含 ESLint 配置):

1. 安装 Prettier

bash 复制代码
npm install --save-dev prettier

2. 创建 Prettier 配置文件

在项目根目录下创建 .prettierrc.js(或 .prettierrc.json):

javascript 复制代码
module.exports = {
  // 单引号
  singleQuote: true,
  // 句尾不使用分号
  semi: false,
  // 每行代码最大长度
  printWidth: 100,
  // 对象属性末尾加逗号(尽可能)
  trailingComma: 'all',
  // 箭头函数单参数时不加括号
  arrowParens: 'avoid',
  // HTML 文件空格敏感性
  htmlWhitespaceSensitivity: 'ignore',
  // Vue 文件中 script 和 style 标签缩进
  vueIndentScriptAndStyle: true,
  // 换行符自动检测
  endOfLine: 'auto'
}

或者使用 JSON 格式(.prettierrc.json):

json 复制代码
{
  "singleQuote": true,
  "semi": false,
  "printWidth": 100,
  "trailingComma": "all",
  "arrowParens": "avoid",
  "htmlWhitespaceSensitivity": "ignore",
  "vueIndentScriptAndStyle": true,
  "endOfLine": "auto"
}

3. 创建忽略文件

创建 .prettierignore 文件,指定不需要格式化的文件/目录:

复制代码
node_modules
dist
*.md
*.json
*.yaml
*.yml

4. 添加格式化脚本

package.jsonscripts 部分添加:

json 复制代码
{
  "scripts": {
    "format": "prettier --write .",
    "format:check": "prettier --check ."
  }
}

5. 配置 VS Code(可选)

如果你使用 VS Code,可以安装 Prettier 扩展,然后创建 .vscode/settings.json

json 复制代码
{
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.formatOnSave": true,
  "[vue]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

6. 使用 Prettier

  • 手动格式化整个项目:

    bash 复制代码
    npm run format
  • 检查格式问题(不修改文件):

    bash 复制代码
    npm run format:check

7. 与 Vite 集成(可选)

虽然 Prettier 通常不需要与 Vite 直接集成,但如果你想在开发过程中自动格式化,可以安装:

bash 复制代码
npm install --save-dev vite-plugin-prettier

然后在 vite.config.ts 中添加:

typescript 复制代码
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import prettier from 'vite-plugin-prettier'

export default defineConfig({
  plugins: [
    vue(),
    prettier({
      // 配置选项,与.prettierrc.js一致
      singleQuote: true,
      semi: false,
      // 其他配置...
    })
  ]
})

这样配置后,你的 Vue3 + TypeScript + Vite 项目就拥有了完整的 Prettier 格式化支持,可以保持代码风格一致。

相关推荐
QCY16 小时前
「完全理解」1 分钟实现自己的 Coding Agent
前端·agent·claude
一拳不是超人16 小时前
Electron主窗口弹框被WebContentView遮挡?独立WebContentView弹框方案详解!
前端·javascript·electron
anyup16 小时前
🔥2026最推荐的跨平台方案:H5/小程序/App/鸿蒙,一套代码搞定
前端·uni-app·harmonyos
雮尘17 小时前
如何在非 Claude IDE (TARE、 Cursor、Antigravity 等)下使用 Agent Skills
前端·agent·ai编程
icebreaker17 小时前
Weapp-vite:原生模式之外,多一种 Vue SFC 选择
前端·vue.js·微信小程序
icebreaker17 小时前
重走 Vue 长征路 Weapp-vite:编译链路与 Wevu 运行时原理拆解
前端·vue.js·微信小程序
wuhen_n17 小时前
代码生成:从AST到render函数
前端·javascript·vue.js
喝咖啡的女孩17 小时前
浏览器前端指南
前端
wuhen_n17 小时前
AST转换:静态提升与补丁标志
前端·javascript·vue.js
喝咖啡的女孩17 小时前
浏览器前端指南-2
前端