用途
Quality Tools 用于定义和规范代码质量工具的使用方式,帮助在开发流程中统一类型检查、lint、格式化与重构评审的做法。它既给出具体工具(ESLint、Prettier、tsc、linter)的使用模式,也提供一份语言中立的、以提升内聚性和可测试性为目标的重构操作目录。
主要能力
- 工具选择决策树:根据所需的质量检查类型,选择语言特定的类型检查器(tsc、mypy、cargo check)、linter(eslint、clippy、ruff、biome lint)、formatter(prettier、ruff format、cargo fmt、biome format),或使用 biome check 以单一工具同时完成两者;执行顺序为 types → lint → format。
- 重构操作目录:收录语言中立、保持行为不变的有界操作,强调应用能解决当前问题的最小操作,而非大范围重写。
- 评分式评审骨架:为性能、文档或通用设计等多维质量评审提供输出结构,把笼统的“评审”转化为按优先级排序、可执行的报告。
- 最佳实践与反模式:给出推荐做法与需要避免的做法。
- 错误升级规则:按严重程度对问题分级处理。
使用方式
- 先运行类型检查器再运行 linter,以获得更快的反馈。
- 自动修复后通过测试进行验证;不要未经审查就接受自动修复的改动。
- 有项目特定配置时使用项目配置。
- 报告所有问题时附带 file:line 位置。
- 对大型代码库运行增量检查。
- 在提交中把格式化与逻辑改动分开。
- 优先采用最小的提升内聚性的重构操作(如视图数据提取、barrel 移除、辅助函数拆分),而非大范围重写,并在每次操作后用针对性测试验证行为。
- 评分式评审中,区分 Critical(发布前必须修复)与 Quick Wins(高影响、低工作量)并各自估算工作量,按阶段编排修复顺序(例如先可靠性,再性能,再测试,最后进阶),使报告读起来像一份发布计划而非平铺清单。
适用场景
- 需要在项目中统一类型检查、lint 与格式化流程时。
- 需要把代码质量评审结构化为可执行、分优先级的报告时。
- 需要以最小、保持行为的重构操作改善代码内聚性与可测试性时。
- 需要按严重程度对质量问题分级并决定升级处理时。
限制
- 评分式评审要求如实说明分析依据与局限:架构或静态评审不等于运行时测量,不得把估算的改进或分数当作实测结果呈现。
- 需给出明确的置信度及其已知局限(例如未覆盖真实工作负载、低资源系统、实际性能剖析)。
- 资料未提供具体安装命令、收费方式、支持平台或量化效果等信息。