首页/开发/代码质量与评审速查/编辑器实时检查与自动修复
规范与静态检查65 条

编辑器实时检查与自动修复

把检查前移到编辑器:保存时自动修复(format on save / fix all)与行内提示,让格式类问题不进提交;编辑器读取项目配置,与 CI 保持同一套规则。

把检查前移到编辑器

静态检查最划算的时点是保存的那一刻:编辑器读取项目内的配置文件,在文件里直接标出问题并给出快速修复,保存时自动修掉可安全修复的部分。这样格式与低风险问题在提交前就消失,CI 只承担兜底与门禁,评审也不再被格式噪声稀释。

基本信息

能力行内诊断 / 保存时自动修复 / 单行豁免
配置来源项目内配置文件,随仓库分发
工具形态编辑器插件、语言服务器、内置语言服务
一致性与 CI 使用同一工具版本与规则集

典型使用场景

  • 保存即格式化:缩进、引号、行宽等风格问题不再进入差异
  • 保存即修复:未使用导入、可安全替换的写法就地改掉
  • 行内诊断:类型错误与未定义变量在编辑时暴露,不用等构建
  • 单行豁免:个别必须保留的写法用行内注释写明理由,而不是全局关规则
  • 团队统一:配置随仓库分发,新成员打开项目即获得同一套检查

VS Code 关键设置

VS Code 关键设置
{
  "editor.formatOnSave": true,
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": "explicit"
  },
  "editor.defaultFormatter": "esbenp.prettier-vscode"
}

哪些问题适合保存时自动修复

问题类型能否自动修处理方式
格式与缩进可以保存时格式化,直接改文件
未使用导入与变量可以检查工具自动移除
简单风格规则可以整文件批量替换
类型与逻辑错误不可以仅行内提示,人工判断
设计类告警不可以留到评审讨论
编辑器与 CI 的工具版本要一致:本地已升到新版检查工具的配置格式、流水线还停在旧配置时,就会出现本地干净、CI 报错。把工具版本写进依赖清单或容器镜像,能省掉大量来回排查。
格式化器与检查工具的规则会打架:把纯格式类规则交给格式化器,检查工具侧关掉这些规则,避免保存时两边反复改写同一行。

易错点

  • 编辑器工具与 CI 版本不一致:本地干净、CI 报错,团队开始怀疑检查本身
  • 保存时全量重排大文件:历史记录里出现巨量无关差异,评审与责任追溯都被破坏
  • 为了「无感」关掉全部规则:真问题被一起静默,检查形同虚设
  • 只写在个人设置里:换台机器或新同事就没有,应写入工作区配置随仓库分发

数据来源与参考

  • VS Code 文档(Format on Save / Code Actions)、ESLint 编辑器集成文档
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌