在开发或者团队协作中,经常需要做编码标准检查,比如检查代码缩进、命名规范、注释完整性等。但问题来了——这些检查结果能不能导出?特别是当你要把问题汇总发给同事或留档时,光靠截图可不够用。
常见的编码检查工具支持导出吗?
像 ESLint、Prettier 这类工具,默认情况下会输出终端日志,但它们其实都支持导出为结构化格式。比如 ESLint 可以通过命令行参数导出为 JSON 或 CSV:
eslint src/ --format json --output-file report.json
这样就能生成一个 report.json 文件,里面包含了所有不符合编码标准的文件路径、错误类型和行号信息。有了这个文件,下一步就可以导入到 Excel 表格里分析了。
怎么把检查结果变成表格?
假设你已经拿到了 JSON 格式的报告,打开 Excel,选择“数据”选项卡,点击“从文本/CSV”导入,虽然它是 JSON,但新版 Excel 支持直接解析。导入后,你会看到每一项错误都被拆成了列:文件名、行数、错误信息、严重等级。
如果你拿到的是 CSV 格式,那就更简单了,直接双击打开就行。之后可以按“严重等级”排序,标出哪些是必须修复的错误,哪些只是建议优化。
自定义导出模板,提升效率
有些团队用的是内部系统做编码检查,界面上看得到结果,就是没法批量导出。这时候可以看看浏览器开发者工具里的网络请求。打开 F12,刷新页面,找到那个返回检查结果的 API 请求,复制它的响应数据(通常是 JSON),保存成文件。
然后用 Python 写个小脚本转成 CSV:
import json
import csv
with open('report.json', 'r') as f:
data = json.load(f)
with open('report.csv', 'w') as f:
writer = csv.writer(f)
writer.writerow(['File', 'Line', 'Message', 'Severity'])
for item in data:
for message in item.get('messages', []):
writer.writerow([
item.get('filePath'),
message.get('line'),
message.get('message'),
message.get('severity')
])
运行完就多了一个 report.csv,双击用 Excel 打开,格式清清楚楚,还能加筛选、标颜色,方便分派任务。
小技巧:定期生成报表邮件
如果你们每周都要交一次编码质量报告,完全可以把上面的流程自动化。写个脚本定时跑 ESLint,导出 CSV,再用邮件脚本自动发送给相关人。你自己只需要盯着表格里红色变少就行。
编码标准检查不是走形式,导出结果才是让它落地的关键一步。别让好规则烂在终端里,导出来,放进表格,才能真正推动改进。