← 中文资源

简体中文版本

用 Prettier 保持格式化确定性

以 Prettier 为唯一格式化权威,为生成产物添加忽略文件,并在 CI 中强制检查,使差异不再混入格式噪声。

阅读英文原文

概述

编辑器设置与个人习惯混杂,会让每个 PR 都塞满空白改动,把真正的逻辑变更淹没。让 Prettier 独占格式化、以忽略文件排除生成代码、并由 CI 检查漂移,可把评审重新聚焦到逻辑本身。

关键步骤

  1. 在仓库根统一配置 Prettier 并移除竞争性格式化器。
  2. 用 .prettierignore 排除构建产物、生成文件与第三方代码。
  3. 在 CI 中运行 prettier –check 并对漂移失败。
  4. 与编辑器集成,实现保存即格式化。

验证

  • 仓库只有一个格式化权威。
  • 生成文件不被重排。
  • 未格式化文件在 CI 中导致失败。
  • 评审差异不含格式噪声。

注意事项

  • Prettier 带有自己的风格主张,采用即意味着接受其输出风格。
  • 全仓格式化会产生巨大差异,应与逻辑变更分开提交。

适用范围

本条目围绕「用 Prettier 保持格式化确定性」给出可复制的步骤、验证方式与常见问题,适合需要按此流程落地的工程团队。执行时请结合自身上下文调整命令与阈值,并在变更前后留存证据,便于后续复核与回滚。

npx prettier --check .
npx prettier --write .
# .prettierignore
dist
coverage
*.generated.ts