file-analysis
映射代码库文件结构与模块组织关系
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:file-analysis。 它的用途是:映射代码库文件结构与模块组织关系 完整的 Skill 内容见:https://321skill.com/skills/file-analysis/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
'帮我分析当前项目(/workspace/myapp)的文件结构,标记模块间的引用关系,输出为 Markdown 表格。' 它会先扫描目录树,然后解析每个文件中的 import/require 语句,生成一张包含模块名、层级、被引用数的表格,并注明关键模块的调用链,方便你快速识别核心模块和高耦合区域。
介绍
在接手遗留项目、规划大规模重构或评估代码迁移范围时,最耗时的往往是理解现有代码库的骨架——文件如何分布,模块之间如何依赖。本项目提供可安装的 Skill,能自动扫描项目目录,生成清晰的层级结构树,并识别模块间的调用与引用关系,帮助你在几分钟内摸清代码全貌,避免因盲人摸象导致的决策失误。
使用方式非常直接:在项目根目录执行安装命令后,运行一次扫描即可输出结构图。该工具支持按文件类型、模块名称或关键词过滤,并可将结果导出为 Markdown 或 JSON 格式,便于嵌入文档或供后续分析工具消费。对于大型仓库,它还支持增量扫描和缓存,仅关注变更部分,提高效率。
核心用户是后端开发、全栈开发以及智能体开发工程师,尤其在架构评审、重构可行性分析、拆解开发任务、评估技术债务时需要快速掌握代码组织。项目经理或技术负责人也可用它来初步评估项目复杂度和工作量,但需结合业务逻辑判断。
建议在每次重大变更前先运行一次扫描,将结果作为团队共享的基线参考。注意该工具仅能从文件系统和静态引用层面理解模块关系,不适用于分析运行时动态加载或反射调用的依赖,也不适合作为代码质量检测的替代方案。对于极大型项目(如百万级文件),首次完整扫描可能需要较长时间,建议先配置排除目录。
核心特点
不同于 tree 命令或 IDE 的文件浏览器只展示目录树,本 Skill 能识别模块间的引用和依赖关系,并输出可用于架构图生成的关联数据,特别适合在评审会议前快速生成项目结构全景。
注意事项
无法分析运行时动态加载的模块或反射调用,且对非标准构建工具(如自定义脚本)的依赖关系识别可能不准确。
常见问题
这个工具支持哪些编程语言?
支持主流语言如 JavaScript/TypeScript、Python、Java、Go、Rust 等,通过解析导入语句识别模块关系,对未注册的扩展语言可通过自定义规则扩展。
和直接用 grep 或 find 命令有什么区别?
本工具不仅列出文件,还交叉索引模块间的引用,输出结构化的依赖关系,便于后续生成架构图或进行影响范围分析。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/file-analysis/raw/index.md 读取 file-analysis 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/file-analysis/raw/index.md(查看排版版本)