0

0

VSCode中的代码格式化:Prettier与EditorConfig

P粉986688829

P粉986688829

发布时间:2025-12-25 11:30:50

|

956人浏览过

|

来源于php中文网

原创

VSCode中Prettier与EditorConfig配合最稳:前者重写式格式化代码样式,后者统一编辑器基础行为,二者分工互补。需安装对应插件、配置.editorconfig和.prettierrc,并设Prettier为默认格式化工具。

vscode中的代码格式化:prettier与editorconfig

VSCode里代码格式化靠Prettier和EditorConfig配合最稳——前者负责具体样式(比如分号、引号、括号换行),后者统一基础编辑器行为(比如缩进大小、换行符类型)。两者不冲突,反而互补。

为什么需要同时用Prettier和EditorConfig

EditorConfig只管“编辑器层面”的约定,比如告诉VSCode:“这个项目用2个空格缩进、LF换行、UTF-8编码”。但它不决定代码长什么样——比如if后面要不要加空格、对象属性结尾要不要逗号,这些得靠Prettier。

Prettier是“重写式”格式化工具:它把代码解析成AST,再按规则输出全新格式。EditorConfig则只是给编辑器发指令,不碰代码逻辑。所以二者分工明确,一起用才能既统一协作习惯,又保证代码风格一致。

在VSCode中正确配置两者

  • 装好插件:Prettier(官方扩展)和EditorConfig for VS Code微软维护)
  • 项目根目录放.editorconfig,内容类似:
    [*]
    indent_style = space
    indent_size = 2
    end_of_line = lf
    charset = utf-8
    trim_trailing_whitespace = true
    insert_final_newline = true
  • 配Prettier:可建.prettierrc(JSON/YAML)或直接在settings.json里写规则,例如:
    "prettier.singleQuote": true,
    "prettier.trailingComma": "es5",
    "prettier.bracketSpacing": true
  • 关键一步:在VSCode设置中启用“保存时自动格式化”,并指定默认格式化工具为Prettier(右下角点击格式化工具图标可设)

避免常见冲突点

EditorConfig和Prettier都支持缩进、换行等设置,但优先级不同。Prettier会覆盖EditorConfig中它自己能控制的项(如indent_size),而EditorConfig仍主导VSCode本身的编辑行为(比如新建行时自动缩进几格)。

海外代购系统源码
海外代购系统源码

该软件是一个以asp+access进行开发的代购企业网站源码。代购优势:随着经济全球化与互联网的发展,带动了许多新新行业,也不缺少成功的案例,淘宝只是其中的一个。而在物流行业中,像代购网站和转运网站都是非常有发展潜力的,消费者可以通过代购网站买到在国内买不到的东西,并且价格也会相对便宜,这些都是代购的优势。代购方式包括有:代购、直购、团购、秒杀、拼单等,首先由客户提交代购订单,然后进行物流选择,可

下载
  • 别在.prettierrc里设tabWidth的同时,又在.editorconfig里设indent_size为不同值——虽然Prettier最终生效,但容易让人困惑
  • 如果用了ESLint,建议加eslint-config-prettier关掉所有和Prettier冲突的规则,再通过eslint-plugin-prettier把Prettier当ESLint规则跑
  • 某些语言(如Vue、Markdown)需额外配Prettier插件(prettier-plugin-vue等),否则格式化可能不生效

团队协作时的小提醒

EditorConfig文件必须提交到仓库,它是跨编辑器、跨IDE的通用契约;Prettier配置也建议提交,避免有人本地用默认配置导致格式化结果不一致。

可以加一条package.json脚本:"format": "prettier --write .",方便一键格式化整个项目。CI流程里也可以加校验步骤(prettier --check .),防止不规范代码合入主干。

基本上就这些——配置一次,后续写代码时几乎不用操心格式问题。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

400

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

528

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

305

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

67

2025.09.10

if什么意思
if什么意思

if的意思是“如果”的条件。它是一个用于引导条件语句的关键词,用于根据特定条件的真假情况来执行不同的代码块。本专题提供if什么意思的相关文章,供大家免费阅读。

700

2023.08.22

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

616

2023.07.31

python中的format是什么意思
python中的format是什么意思

python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

424

2024.06.27

vscode
vscode

VS Code(Visual Studio Code)是一款免费、开源的跨平台代码编辑器,由微软开发和维护。它被广泛用于软件开发和编程,支持多种编程语言和框架。VS Code 同时提供了丰富的功能和扩展性,使开发者可以高效地编写、编辑和调试代码。

576

2023.06.30

苹果官网入口直接访问
苹果官网入口直接访问

苹果官网直接访问入口是https://www.apple.com/cn/,该页面具备0.8秒首屏渲染、HTTP/3与Brotli加速、WebP+AVIF双格式图片、免登录浏览全参数等特性。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

10

2025.12.24

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Vue 教程
Vue 教程

共42课时 | 5.4万人学习

Vue3.x 工具篇--十天技能课堂
Vue3.x 工具篇--十天技能课堂

共26课时 | 1.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号