SuperAPI AI 工具集

tidy-project-structure

办公与效率

查看项目

更新于 10-16 03:42

技能介绍

用途:当项目组织偏离惯例时使用,例如文件散落无清晰结构、README过期或示例失效、配置文件重复(dev/staging/prod漂移)、废弃文件留在根目录、命名约定不一致。不适用于代码重构或依赖调整,仅聚焦文件组织与文档卫生。

主要能力:按语言惯例审计目录布局(JS/TS、Python、R、Rust各有标准结构);用git mv迁移错位文件并保留历史;检查README新鲜度(最后修改时间、断链、失效示例、缺失章节);修复断链、更新版本号与示例、补章节;审查配置文件漂移与硬编码密钥;归档或删除废弃文件并记录ARCHIVE_LOG.md;核对命名约定(kebab-case、snake_case、PascalCase、camelCase);最终生成TIDYING_REPORT.md。

输入参数:project_path(必填,项目根绝对路径);conventions(可选,风格指南路径);archive_mode(可选,move默认或delete);readme_update(可选,默认true)。

必要命令示例:grep -r "filename" .;git mv source/file target_directory/file;find . -name "README.md" -o -name "readme.md";git log -1 --format="%ci" README.md;markdown-link-check README.md;mkdir -p archive/YYYY-MM-DD/;git rm filename。

验证清单:文件位于约定目录、README无断链、示例可运行、配置已检查密钥、废弃文件带文档归档、命名一致、用git mv保留历史、迁移后测试仍通过。

限制:不使用mv以免丢失历史;移动可能破坏相对导入,需更新引用,复杂问题可转交相关技能(clean-codebase、repair-broken-references、escalate-issues)。文档示例无法验证时应标注警告,是否归档存疑则保留并记录。