SuperAPI AI 工具集

mir-review-snippet

通用与其它

查看项目

更新于 10-16 08:46

技能介绍

用途:审查 mir snippet 的质量并给出改进建议。适用于用户提出「审查 snippet」「确认质量」「发布前检查」「检查 snippet 是否有问题」等请求时。

主要能力与审查维度:变量设计(变量名是否表意清晰、schema 的 type/default/enum 是否合适、派生值是否用 default 模板表达式、description 在安装提示中是否易懂、是否用 suggests 提供选项);模板质量(模板助手 lowercase、uppercase、capitalize、uncapitalize、camelCase、pascalCase、snakeCase、kebabCase、dotCase、pathCase、replace、concat、slice、trim、contains、startsWith、endsWith、length 是否恰当使用,单一变量是否正确展开为多种命名规则,生成代码可读性、是否存在多余硬编码、Handlebars 条件与循环是否恰当);hooks 的 UX(before-install 行为是否说明、after-install 是否引导依赖安装与配置变更等后续操作、exit 条件是否合适);注释与可维护性(snippet 定义 YAML 是否有维护注释、每个模板文件是否记录来源路径、是否保留设计意图与决策、后续维护者能否据此修改);元数据(description 是否准确、tags 是否便于检索、version 是否设置);安全性(模板文件名是否含路径穿越 ..、是否存在意外覆盖文件的风险、snippet.yaml 的 name 是否与文件名一致)。

使用方式:读取 .mir/snippets/<name>.yaml 与该目录下的全部文件,按上述维度审查并输出问题与改进清单,标注严重度(高/中/低);经用户批准后实施修改,再用 npx mir sync <name> 同步变量并验证,可用 npx mir install <name> --out-dir=/tmp/mir-test-<name> 测试安装。

限制:并非所有条目都必须满足,需按 snippet 用途判断;hooks 非必需,但若设置了需检查其 UX。资料未提供收费、价格、平台与效果信息。