为什么需要格式化 js 代码
JavaScript 语法灵活,同一段逻辑可以有多种排版写法。缩进用两个空格还是四个空格、单引号还是双引号、行尾要不要加分号,这些分歧本身不影响运行结果,却会在多人协作时制造大量无意义的差异。
js代码格式化的核心价值在于把“风格问题”从讨论中移除:机器负责排版,人负责逻辑。带来的直接收益包括代码评审时噪音更少、合并冲突更容易定位、新成员不必猜测项目习惯。
主流工具怎么选
目前前端生态里常见的方案有三类。
Prettier 类格式化器:只管排版,不做语义检查,配置项少,开箱即用,对 JSX、TS、CSS、Markdown 等多种文件都支持。适合希望“少争论、统一快”的团队。
ESLint 的格式化规则:ESLint 本质是静态检查工具,其中一部分规则涉及缩进、引号等排版问题。它的问题是规则之间容易冲突,维护成本偏高。
两者配合:常见做法是让 Prettier 负责排版,ESLint 负责逻辑与潜在错误检查,并通过配置关闭 ESLint 中与排版重叠的规则,避免互相打架。
关键配置项的含义
无论用哪种工具,有几个配置项值得理解清楚,而不是照抄模板。
printWidth:单行最大宽度,超过后格式化器会尝试换行。设得太小会导致大量折行,设得太大则不利于并排查看代码。tabWidth与useTabs:决定缩进宽度和用空格还是制表符。团队统一即可,没有绝对优劣。semi:是否在语句末尾加分号。依赖 ASI(自动分号插入)的代码在少数边界情况下容易出问题,统一风格比选哪种更重要。singleQuote:字符串用单引号还是双引号,纯风格问题。trailingComma:多行结构末尾是否保留逗号,影响后续增删行的 diff 大小。
忽略文件要提前规划
构建产物、压缩后的第三方库、自动生成的代码目录,都应该写进忽略配置。否则格式化会覆盖不该动的文件,甚至让构建结果发生变化。
把格式化接入工作流
只装工具不接入流程,格式化很快会退化。比较稳妥的三层做法:
- 编辑器保存时格式化:在编辑器设置中指定默认格式化器,保存即生效,开发者几乎无感知。
- 提交前钩子:用 husky 配合 lint-staged,只对本次暂存的文件执行格式化,速度快,也不会一次性改动整个仓库。
- CI 校验:在流水线中增加一步“检查格式”,发现未格式化文件直接失败,防止绕过本地钩子的提交进入主干。
落地时的几个提醒
首次引入格式化工具时,建议单独提交一次“全量格式化”的 commit,并在提交信息中注明,方便后续用 blame 时跳过这次提交。同时把配置文件纳入版本管理,避免每个人本地设置不同。
另外,格式化不能替代代码评审。它能消除排版争议,但命名、拆分粒度、边界处理这些真正影响质量的问题,仍然需要人来判断。
把 js代码格式化当成工程规范的一部分,而不是一次性任务,风格一致性才维持得住。