SuperAPI AI 工具集

change-walkthrough

通用与其它

查看项目

更新于 10-16 08:45

技能介绍

用途:为代码变更生成结构化的 Markdown 走查文档,并自动转换为 HTML 在浏览器中预览,便于解释改动、审查提交。

主要能力:支持多种变更范围,包括未提交改动(默认)、已暂存改动、最近 N 次提交、提交区间(如 abc123..def456)、分支对比以及指定文件或目录。文档包含标题、日期、范围、文件统计、摘要、文件变更表、逐项详细说明(含 file:line 引用与语法高亮代码片段)、测试注意事项,并按 kebab-case 生成文件名。

使用方式:先确定审查范围,再运行相应 git 命令收集信息,例如未提交改动用 git diff --stat && git diff,已暂存用 git diff --staged --stat && git diff --staged,最近 N 次提交用 git log --oneline -n N && git diff HEAD~N..HEAD,分支对比用 git diff main..HEAD --stat && git diff main..HEAD。随后生成 Markdown 并写入技能目录的 tmp 下,路径为 {SKILL_BASE_DIR}/tmp/{filename}.md。转换前需在技能基础目录安装依赖并执行转换:cd {SKILL_BASE_DIR} && npm install;node scripts/md-to-html.js {SKILL_BASE_DIR}/tmp/{filename}.md;open {SKILL_BASE_DIR}/tmp/{filename}.html。

适用场景:代码审查、提交说明、向他人解释改动、整理变更记录。

限制:生成文件应存放在技能目录而非用户项目目录;转换脚本依赖 npm 依赖,需先安装;输入输出建议使用绝对路径;资料未提供其他平台支持、收费或效果保证等信息。