code-quality
Check existing-project implementation consistency, simplify recent code changes without altering behavior, or review changes for bugs and regressions. Choose the relevant section by task; review-only requests must not modify files.
apexcheng · Static checks on file
Installation
Read the source and dependencies before running a command. Copying does not install or execute anything.
npx skills add apexcheng/yingdao-xbot-ai-agent --skill code-qualityAbout this skill
name: code-quality description: Check existing-project implementation consistency, simplify recent code changes without altering behavior, or review changes for bugs and regressions. Choose the relevant section by task; review-only requests must not modify files.
代码质量:一致性、简化与审查
先读取项目 AGENTS.md,只进入当前任务涉及的部分:比较已有实现时用「代码一致性」,用户要求精简时用「代码简化」,要求审查时用「代码审查」。需要过程式主流程、变量内联、函数边界或异常收尾等标准时,按需读取 编码标准;新增或调整网页操作流程时,按项目 AGENTS.md 要求在编码前读取其中的「变量与内联」一节。普通明确小改无需全量加载。
代码一致性
修改已有项目时,先查看当前文件、相邻代码和最接近的同类业务实现,沿用其已经验证的 API、控制流、异常处理及日志模式;不要为同一个问题另造等价写法。
- 当前文件 / 模块有成熟先例时直接参考,新增或改变 xbot API 调用契约时仍以知识库正式事实页核对。
- 同类实现不一致时,优先选择与本次业务最接近、当前仍在使用且可确认正确的写法,不顺便统一整个项目。
- 没有适用先例时按项目
AGENTS.md和对应知识页处理,不照搬错误、过时或业务条件不同的示例。 - 修改后仅检查本次代码与附近实现是否无理由产生新的差异;用户明确要求重构、替换旧模式或统一风格时不机械沿用旧代码。
代码简化
只优化本次最近修改的代码,使实现更直接、清晰、符合当前项目习惯;不改变业务行为,不顺手重构无关代码。
先确定范围
优先以当前 git diff、本次会话实际修改文件和用户指定范围为准。
除非用户明确要求扩大范围,否则不要因为发现旧代码也能优化,就继续整理整个文件、模块或项目。
简化前先读取当前项目 AGENTS.md。涉及项目已有实现方式时,同时按 本 Skill 的「代码一致性」部分 检查附近和同类代码,不用通用“最佳实践”覆盖项目已经形成的合理约定。
简化目标
重点检查本次改动是否出现:
- 没有额外语义、只服务下一行调用的一次性临时变量。
- 为当前单次业务步骤新增的薄函数、包装层或中转参数。
- 同一 Page 的连续操作被拆成无真实复用、无独立职责或稳定后置条件的薄函数;按 编码标准 判断,必要时还原清晰的主流程。
- 可以直接表达却被拆成初始化再覆盖、重复判断或多余状态的逻辑。
- 不必要的嵌套、重复分支、重复转换或重复读取。
- 已有成功时间和跳过机制仍新增跨轮文件缓存、额外状态源,或没有明确业务需求却新增关闭 / 重开工作簿、补跑和回滚分支。
- 只为形式分层新增的 Service、Manager、Context、Helper 等业务抽象。
- 与当前模块已有代码相比明显更绕、更啰嗦或采用了第二套等价写法的实现。
- 逐行复述代码、没有解释业务意图的注释。
简化时优先让真实业务顺序直接可见,并遵守项目已有的函数边界、日志、异常处理和 xbot API 使用方式。
表格更新 RPA 的独立 Sheet 失败继续、最后统一保存等固定规则,直接按 表格操作 Skill 执行,不额外添加重开和回滚流程。
保持行为不变
简化不是重新设计。不得无理由改变:
- 业务条件、执行顺序、循环边界和停止条件。
- 将多个函数合并回主流程时,检查原函数的局部变量是否覆盖外层循环变量或业务状态;同时保持原有执行顺序、异常处理、返回值和页面状态不变。
- 返回值、数据结构、异常传播和失败语义。
- 日志中承担排查价值的业务上下文。
- 用户已确认的字段名、XPath、CSS、URL、按钮文案、Sheet 名、状态值和配置值。
- xbot / 市场指令的 API、参数、调用时机和页面交互顺序。
- 已有必要封装提供的后置条件,例如“返回一个已经登录且可直接使用的 page”。
如果无法确认某个改写是否保持行为一致,就不要为了更短或更“优雅”而修改。
不要过度简化
目标不是减少行数。
以下情况应保留显式结构:
- 分支包含多个业务动作、副作用或异常处理。
- 运行时中间结果会复用、参与后续判断,或名称能明显解释计算结果的业务含义;固定字面量是否提取按 变量与内联 判断。
- 函数 / 类确实隐藏一组实现细节,并向调用方提供稳定完整的结果或后置条件。
- 展开写法更方便排查、调试或理解真实业务顺序。
不要生成密集 one-liner、复杂条件表达式、难读的链式调用或仅为了“更少代码”合并多个业务步骤。
完成后验证
修改后重新检查 diff,确认:
- 只修改了本次简化范围。
- 没有引入与当前项目不同的新实现模式。
- 业务行为、失败语义和关键常量没有变化。
- 本次新增的模块常量、局部变量和配置项符合 变量与内联,没有将应就地内联的固定值提取出去。
按项目 AGENTS.md 的验证规则做与本次简化直接相关的最小必要验证。没有实际运行或可验证证据时,只能说明静态检查结果,不能声称业务运行行为已经验证一致。
如果当前改动已经足够直接清楚,不需要为了执行本 Skill 而强行产生新的代码修改。
代码审查
审查分为两条独立轴:Spec 检查是否忠实实现用户需求、是否遗漏或擅自增加行为;Standards 检查是否违反项目明确规范与 xbot 契约。代码气味仅作为判断线索,不等于违反硬约束。两轴分别给出结论,不用编码风格掩盖业务错误,也不以需求通过掩盖规范违反;不为此强制创建两个子 Agent。
审查范围
默认从当前 git diff 和本次会话实际修改范围开始;用户指定文件、提交或模块时按用户范围审查。
先读取适用于目标文件的 AGENTS.md、正式 PRD / 规范和必要的项目上下文。涉及同类实现是否一致时,按 本 Skill 的「代码一致性」部分 比较当前项目先例。
不要把本次改动之外的历史问题混入结果。发现无关旧问题可以忽略;只有它被本次改动直接放大或触发时才报告。
证据边界与差异复审
- 将审查发现区分为已证实的问题、证据不足的待核实事项、已明确接受的业务取舍;审查材料未提供测试执行输出,只能说本次无法独立确认,不能据此断言测试未通过。
- 结论不超过实际读取的源码、执行记录和用户确认事实;涉及行为是否通过实机验证时,交代证据来自哪里,不把模拟测试等同于真实业务运行。
- 首轮按问题读取必要的关联代码;整改后的复审优先核对本次差异、受影响调用路径及上一轮问题,发现新的跨模块影响时再扩大范围,不机械重复全量审查。
- 缺少明确需求或验收依据时,标记 Spec 无法完整核实,不能写成通过。
重点检查
1. Spec|业务与逻辑正确性
- 条件、分支、循环、停止条件、状态更新是否与需求一致。
- 是否符合用户已确认的业务规则、PRD 和验收要求;是否夹带未要求的行为。
- 是否漏处理本次需求明确覆盖的场景。
- 是否改变原有业务口径、执行顺序、返回值或副作用。
- 边界值、空结果、重复数据等是否会在当前真实业务中产生错误结果。
2. Standards|项目规则与实现一致性
- 是否违反当前项目
AGENTS.md中的编码与执行约束、编码标准 或明确的 API 规范。 - 同类问题已有成熟实现时,是否无理由改用了另一套 API、控制流、异常或日志方式。
- 是否为一个小改动引入无必要的新抽象、封装层或长期状态。
- 无用 Code Flow 核实:
package.json登记了某个 Flow,只能证明它被登记,不能证明存在“旧流程依赖”;不能仅凭文件注释推断兼容用途。先核对启动流、Visual Flow 调用、实际 import / 调用及已知外部入口,再判断是否有依赖。确认无用途且本轮授权清理时,删除空壳.py的同时同步对应 Flow 登记,不留下无意义的兼容入口;仅凭未发现 Python import 也不能断言一定无人使用。 - 新增的模块常量、局部变量和配置项是否符合 变量与内联 的例外和最小作用域要求。
- 是否为了理论上的失败新增无需求的回滚 / 重新打开工作簿 / 跨轮下载缓存。
3. Standards|xbot / 外部能力
- 不根据通用 Python、Selenium、Playwright 经验猜 xbot API。
- 对本次新增或改变的影刀 API / 市场指令调用,以及有争议或出现异常的用法,按知识库正式事实页核验;未改变契约且项目已有相同用法时可直接核对现有实现。项目成熟实现不覆盖正式 API 事实。
- 检查 XPath、字段、请求响应结构、页面状态或 Profile 等是否被本次改动错误假设。
- 页面加载是否遵循项目已确认的等待约定;WPS 操作按 表格操作 Skill 核对,不另存一份规范。
4. 异常与失败语义(按证据归入 Spec 或 Standards)
- 是否吞掉异常后继续把业务当作成功。
- fallback、默认值或空值是否把技术失败伪装成正常业务数据。
- 是否错误扩大
try/except范围,吃掉不应捕获的失败(Standards)。 - 补充业务上下文时是否仍保留原始异常链(Standards)。
- 收尾、重试和日志是否会覆盖真正的主异常或误报最终结果。
5. Spec|实际副作用
- 是否重复提交、重复点击、重复写回、重复通知或漏执行必要动作。
- 是否因执行顺序变化导致页面、文件、数据库或外部状态与原行为不同。
- 是否修改了用户没有要求变化的接口、配置、持久化格式或长期业务规则。
- 防止顺手扩展: 已确认的任务仅要求数据补采、巡检与重试时,不顺便建设场次状态维护、失败恢复状态体系或其它业务功能。发现与本次目标无直接阻塞关系的问题,只记录待办,不自动整改;不得为了让测试更全面而先增加新功能。确属阻塞且会改变业务行为或扩大范围时,先请用户决定。
过滤低价值问题
不要报告:
- 纯个人审美、可改可不改的写法。
- “另一种实现也不错”但当前代码没有问题的建议。
- 仅为了 DRY、SOLID、函数更短、抽象更多而提出的重构。
- 格式化、拼写或普通 lint 能直接处理且不影响当前任务的问题。
- 与本次改动无关的既有问题。
- 缺乏实际证据、只是理论上可能发生的低概率问题。
Spec 只报告有证据、影响需求或结果的问题;Standards 报告明确规范违反,主观代码气味只有在收益明显且有证据时才列为建议,不能冒充硬约束。
输出要求
每个问题至少说明:
- 严重程度。
- 文件和具体位置。
- 为什么这是实际问题,而不是偏好差异。
- 会造成什么业务或运行影响。
- 最小修复方向。
分别以 Spec、Standards 两组输出,可在各组内按 P0 / P1 / P2 排序,不跨轴合并或重排;明确区分规范违规和判断性建议。没有高置信问题时,直接说明未发现需要修改的问题,不为了让 Review 看起来有产出而硬找问题。
代码审查默认只给结论和修复建议;只有用户明确要求修复,或当前任务本身包含“审查并修复”时,才继续修改代码。