S2 Lint 是一个面向 AntV S2 项目仓库开发的代码规范检查技能,其核心用途是在代码修改完成后统一执行 lint,确保改动符合项目的类型、语法、样式、文档与用词规范,避免带错误推送代码。
适用时机:在修改 packages/ 目录下的任何代码文件后、结束任务前,必须使用该技能。涵盖的场景包括但不限于:修改 .ts、.tsx、.vue 文件,新增源码文件,修改类型定义文件(.d.ts),修改导入/导出语句,修改 .less 样式文件,修改 .md 文档文件。
主要能力与检查项:在项目根目录运行 pnpm lint,该命令依次执行五项检查:lint:type(TypeScript 类型检查)、lint:script(ESLint 代码风格检查)、lint:style(Stylelint CSS/LESS 检查)、lint:docs(MarkdownLint 文档检查)、lint:word(case-police 单词大小写检查)。
使用方式:完成所有代码修改后,在项目根目录执行 pnpm lint;如命令报错,需仔细阅读错误信息以确定错误位置与原因,修复全部错误,再重新运行 pnpm lint 确认问题已解决。只有 lint 通过后任务才视为完成。
限制与注意事项:不得忽略 lint 错误,否则可能导致 CI/CD 流水线构建失败;若某些错误难以修复,应告知用户并讨论解决方案;该检查是推送代码到 git 前的必要步骤。