如何在VS-Code配置代码格式化Prettier插件统一风格

胖涛君_2464

胖涛君_2464

2026-04-21

868人浏览

原创

prettier.requireconfig 必须设为 true,否则 vs code 会退化为内置格式器导致风格不一致;需在 .vscode/settings.json 中配置该值、指定 editor.defaultformatter 为 esbenp.prettier-vscode、使用本地 prettier.prettierpath 并配好 .prettierrc.json5。

如何在vs-code配置代码格式化prettier插件统一风格

prettier 在 VS Code 中不是装上插件就自动统一风格的——它默认会退化成编辑器内置格式器,尤其在没有项目级配置时,不同人保存出来的代码缩进、引号、分号、JSX换行全可能不一致。

prettier.requireConfig 必须设为 true

这个配置是团队协作的底线。
不启用它,VS Code 会按自己理解的“合理格式”去格式化,比如对 Vue 文件里的 <template></template> 可能用 prettyhtml,对 .js 可能走 TypeScript 内置格式器,结果就是:

  • 同一个文件里 HTML 和 JS 风格割裂
  • npm run format 和 Ctrl+S 输出不一致
  • Git 提交里全是无意义的格式变更

正确做法是:

  • 在项目根目录的 .vscode/settings.json(工作区设置)中写入:
    "prettier.requireConfig": true
  • 同时确保项目里有 .prettierrc 或 .prettierrc.json5
  • 不要只依赖用户级 settings.json,否则新成员 clone 项目后立刻掉坑里

editor.defaultFormatter 要精确指定插件 ID

VS Code 允许多个格式化插件共存,但只认一个“默认”。常见错误是:

  • 只配了 "editor.formatOnSave": true,没指定谁来干这事
  • 混用了 octref.vetur 和 esbenp.prettier-vscode,导致 Vue 文件 template 和 script 格式器打架

必须明确写:
"editor.defaultFormatter": "esbenp.prettier-vscode"
注意:

  • ID 必须完全匹配,大小写都不能错
  • 如果项目用 Vetur,还要额外关掉它的默认 HTML 格式器:
    "vetur.format.defaultFormatter.html": "prettier"
  • 对于 .vue 文件中的 <script></script>,Prettier 默认支持,无需额外桥接

prettier.prettierPath 要指向本地 node_modules

线上 CI、同事本地、你自己机器,Node 版本和全局 Prettier 版本大概率不一致。直接依赖全局安装的 prettier,会导致:

  • 本地格式化正常,CI 报错说 “unexpected token {”
  • 团队有人用 Prettier 3.1,有人用 3.3,printWidth 行为细微差异引发反复 reformat

解决方案:

  • 项目中运行:npm install prettier --save-dev --save-exact
  • 在 .vscode/settings.json 中声明路径:
    "prettier.prettierPath": "./node_modules/prettier"
  • 不要用 ~/.npm-global 或绝对路径,跨平台不兼容

.prettierrc 配置要覆盖语言特例

纯 JSON 不支持注释,容易误删逗号或写错括号;推荐用 .prettierrc.json5。关键点:

  • printWidth: 100 比默认 80 更适配现代显示器,减少无谓换行
  • overrides 是刚需,例如:
    • CSS/SCSS 里强制双引号:{ "files": "*.{css,scss}", "options": { "singleQuote": false } }
    • Markdown 强制软换行:{ "files": "*.md", "options": { "proseWrap": "always" } }
  • 不要盲目抄网上“最佳实践”,比如 semi: false 必须和 ESLint 的 semi: ["error", "never"] 对齐,否则保存即报错

真正卡住团队的往往不是不会配,而是某台机器漏了 prettier.requireConfig,或是 .prettierrc 放错了位置导致被忽略——这些地方没有报错提示,只有提交后大家互相 reformat 才发现风格又乱了。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3109

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2288

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1220

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1178

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1336

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

2118

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

3400

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

15375

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

549

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习