讲师中心 微信公众号
AI工具推荐 视频效率加速

如何用 Prettier 自动格式化代码保持工程风格的高度统一

轻强同学_5830

轻强同学_5830

发布时间:2026-04-04 22:09:35

|

279人浏览过

|

来源于php中文网

原创

Prettier 专责格式(缩进、引号等),ESLint 专责逻辑与风格规则;二者重叠规则必须禁用以防冲突抖动,需通过 eslint-config-prettier 清空 ESLint 格式规则,并优先使用 .prettierrc 配置文件。

如何用 prettier 自动格式化代码保持工程风格的高度统一

为什么 prettier 不该和 eslint 混用格式规则

直接结论:prettier 负责格式(缩进、换行、引号、括号位置),eslint 负责逻辑与风格(如变量命名、禁止 eval、强制 ===)。两者重叠的规则(比如 quotes 或 semi)必须禁用,否则会互相覆盖或报错。

常见错误现象是:保存文件后格式反复“抖动”——刚被 prettier 加了分号,eslint --fix 又删掉;或者 eslint 报出 prettier/prettier 错误却 fix 不了。

  • 在 .eslintrc.js 中加入 "prettier" 到 extends 数组末尾,确保它最后执行
  • 显式关闭所有与格式相关的 eslint 规则:用 eslint-config-prettier,不是可选,是必须
  • 不要手动写 "semi": ["error", false] 这类规则——eslint-config-prettier 已经帮你清空了

prettier 的配置文件到底该用 .prettierrc 还是 package.json

优先用 .prettierrc(支持 json/yaml/js),而不是塞进 package.json。原因很实际:IDE 插件(如 VS Code 的 Prettier 扩展)默认只读 .prettierrc,而 package.json 里的 prettier 字段需要额外配置才能识别,容易漏。

更关键的是,.prettierrc 支持注释(用 .prettierrc.js),方便写说明,比如:

module.exports = {
  // 强制单引号,避免 JSX 中混用引号引发 lint 报错
  singleQuote: true,
  // 行宽设为 80 是为了兼顾 PR diff 可读性,不是教条
  printWidth: 80,
  // 不要末尾逗号 —— TypeScript 接口/类型字面量里加它反而易出错
  trailingComma: "none",
};

注意:printWidth 不是硬性截断,而是“尽量不超过”,Prettier 会根据语法结构智能换行;设太小(如 60)会导致对象字面量被强行拆成 5 行,反而降低可读性。

VS Code 保存时自动格式化但不生效?检查这三处

典型现象:按 Ctrl+S 没反应,或只格式化部分文件,或提示 “No formatter for ‘javascript’ installed”。这不是插件没装,而是配置没对齐。

  • 确认已安装官方 esbenp.prettier-vscode 插件(非其他同名插件)
  • 在用户设置(settings.json)中启用:"editor.formatOnSave": true,且不要在工作区设置里覆盖它
  • 关键一步:为每种语言指定 formatter,例如:
    "[javascript]": {"editor.defaultFormatter": "esbenp.prettier-vscode"}
    "[typescript]": {"editor.defaultFormatter": "esbenp.prettier-vscode"}
    "[json]": {"editor.defaultFormatter": "esbenp.prettier-vscode"}

漏掉语言映射,就等于告诉 VS Code:“JS 文件请用内置格式器,别找 Prettier”——哪怕插件装了也白搭。

Git 提交前自动格式化:用 lint-staged 而不是 pre-commit hook 直跑 prettier

直接在 pre-commit 里执行 npx prettier --write . 很危险:它会格式化整个项目,包括 node_modules(如果路径没 exclude)、构建产物、甚至别人还没 commit 的临时文件。真正要的,只是本次 git add 进暂存区的那些文件。

lint-staged 就是干这个的——它只把暂存区文件路径传给命令,精准、安全、快。

  • 安装:npm install --save-dev lint-staged husky
  • 在 package.json 中加:
    "lint-staged": {"*.{js,ts,jsx,tsx,json,md}": "prettier --write"}
  • 用 npx husky add .husky/pre-commit "npx lint-staged" 绑定 hook

注意路径通配符必须显式列出后缀,* 不匹配隐藏文件(如 .prettierrc),也不匹配嵌套子目录里的文件——除非你加 **/*,但通常没必要,因为 git add 时已明确指定了文件。

最常被忽略的一点:团队成员本地没装 husky 或没启用 hook,提交照样绕过格式检查。所以 CI 流程里仍需加一步 prettier --check 校验,不能只信本地。

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

热门AI工具

更多
Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

4226

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

1069

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

4124

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

840

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

1736

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

3085

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

4013

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

2580

2023.09.20

Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

80

2026.09.23

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn