关于 codebase-cleanup-audit
面向维护代码库的开发者,提供先审计后修改的清理流程,可识别可删除、合并、重命名或归档的内容。通过脚本生成快照,并要求报告依据、风险和验证步骤。
主要功能
- 01按仓库或目录限定审计范围
- 02生成 HTML、JSON 或 Markdown 快照
- 03查找重复、过时及未使用内容
- 04分类整理清理发现与风险
- 05编辑前先报告并给出验证命令
适用场景
- 01检查指定应用或软件包中的冗余文件
- 02查找过时文档、重复配置和临时文件
- 03审查仓库中未使用的导出或依赖
- 04规划安全的清理批次
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ gil-1/ skills --skill codebase-cleanup-audit安装后在 Claude Code 中输入/codebase-cleanup-audit确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlscripts/cleanup-snapshot.mjsscripts/cleanup-snapshot/cli.mjsconfig.mjsduplicates.mjsfunction-scanner.mjsinventory.mjsrenderers.mjsshared.mjssnapshot.mjs详细介绍
代码库清理审计
找出可以删除、合并、重命名、归档或更易管理的内容。先审计;只有用户要求实施时才进行修改。
快速开始
先阅读本地规则,再运行随附的快照工具:
node scripts/cleanup-snapshot.mjs --root /path/to/project
若要进行有针对性的清理,请扫描最小的有效目录,而不是整个代码库:
node scripts/cleanup-snapshot.mjs --root /path/to/project/apps/admin
node scripts/cleanup-snapshot.mjs --root /path/to/project/packages/auth
node scripts/cleanup-snapshot.mjs --root /path/to/project/docs
默认报告路径:扫描根目录下的 .scratch/<datetime>-cleanup-snapshot.html。写入 .scratch 的 HTML 报告会以时间戳为前缀。需要仅供机器读取的标准输出快照时,请使用 --format json|markdown --out -。
如果清理涉及浅层模块、嘈杂的接口、位置不当的接缝、删除测试,或可测试性/局部性问题,请使用 codebase-design。如果清理发现应成为可视化架构候选项,而不是安全的清理批次,请升级至 improve-codebase-architecture。
工作流
- 确定范围:整个代码库、软件包、应用区域、文档、测试、脚本、资源、生成的输出,或工作区杂乱内容。如果请求指定了某个区域,优先使用限定范围的
--root。 - 阅读本地事实来源:
AGENTS.md、CLAUDE.md、README.md、CONTEXT.md、ADR、清单、脚本、CI、软件包导出项、路由、部署配置和文档。 - 使用
cleanup-snapshot.mjs、rg --files、软件包清单、测试配置、路由列表,以及项目中可用的依赖工具,梳理代码库。 - 搜索清理信号:
legacy、old、deprecated、unused、dead、backup、copy、tmp、wip、内容不同但文件名重复的文件、函数体重复的函数、函数体不同但名称重复的函数、通用收纳目录、空文件夹、过时文档、已禁用的测试、跳过的脚本、TODO/FIXME/HACK 集中区、源代码中的生成文件,以及工具支持时未使用的导出项/依赖。 - 对每项发现进行分类:
- 删除:安全的废弃产物、生成的输出、重复副本、过时的临时文件
- 合并:重复文档、重复配置、拆分在多个浅层模块中的相同概念
- 重命名/改写:名称含糊、误导性的技能描述、过时术语
- 归档:可能有用但无需留在活动源代码中的历史内容
- 暂缓:需要产品决策、外部契约、迁移计划或更多证据
- 应用
codebase-design中的删除测试:如果移除模块能减少复杂度,该项可作为清理候选;如果复杂度会扩散到调用方,则应提议改为更深层的模块,并在需要架构探索时将该发现交由improve-codebase-architecture处理。 - 编辑前先报告。包括风险、证据、安全的批次顺序、验证命令,以及不得移动的内容。
输出
## Cleanup Audit
- Scope:
- Local rules:
- Snapshot:
- Safe deletes:
- Merge/dedupe:
- Rename/reword:
- Architecture candidates:
- Keep because:
- Risks/blockers:
- Suggested first batch:
- Verification:
措辞直接明了。优先提供具体文件路径和精确的搜索证据,避免泛泛而谈。
评论
支持 Markdown