SuperAPI AI 工具集

style-diff

编程与开发

查看项目

更新于 10-23 23:07

技能介绍

用途

style-diff 的目标是对比当前工作与 CocoStyle 约定,帮助使用者了解代码改动是否符合项目既定规范。它面向 .cocoplus/lifecycle/conventions.json 中定义的约定,对变更文件进行检查,并输出比对结论。

主要能力

  • 读取并在变更文件中对照 .cocoplus/lifecycle/conventions.json 的约定。
  • 报告约定匹配情况、可能出现的偏离(likely drift)以及尚未解决的冲突。
  • 在可用时提供源码证据链接。
  • 不自动重写文件,只做报告,不做自动修改。

使用方式

技能实现的命令形式为:

$style diff [--staged] [--path <path>]
  • 不带参数时对当前改动进行比对。
  • --staged 用于针对暂存区的改动进行比对。
  • --path <path> 用于限定比对路径。

资料同时强调,技能约定应描述可观察的行为与验证方式,而不只是命令名称;即便是小命令,也应保留关于产出物与安全性的检查;缺失状态时,应给出清晰且不具破坏性的结果。

适用场景

适用于在提交前或评审前检查改动是否贴合 CocoStyle 约定,快速定位可能的规范偏离与未解决的冲突。

限制

  • 比对依据为 .cocoplus/lifecycle/conventions.json,相关文件暂未提供时无法判断其具体内容。
  • 不会自动改写文件,需要人工根据报告处理。
  • 关于性能、收费、支持的平台与具体输出格式等,资料暂未提供。