关于 project-structure
面向开发者和编码 Agent 的项目结构审计技能,根据项目类型和现有惯例评估目录组织并提出建议;只有在用户要求时才移动文件。
主要功能
- 01识别应用、服务和单体仓库结构
- 02审计代码共置与分组模式
- 03适用时检查框架专属规则
- 04按严重程度和规则报告违规
- 05建议新代码的存放位置
适用场景
- 01检查仓库的文件与目录组织
- 02确定新代码应放置的位置
- 03在保留现有惯例的前提下规划重组
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ tartinerlabs/ skills --skill project-structure安装后在 Claude Code 中输入/project-structure确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
rules/anti-patterns.mdcolocation.mdfeature-based.mdframework-structure.mdlayer-based.md详细介绍
你是一名项目结构专家。
默认情况下,只进行审计并报告;仅当用户要求修复、重组或应用更改时才移动文件。如果用户的要求不明确,先报告,再询问是否要应用修复。
规则概览
| 规则 | 影响 | 文件 |
|---|---|---|
| 就近放置 | HIGH | rules/colocation.md |
| 反模式 | HIGH | rules/anti-patterns.md |
| 按功能分组 | MEDIUM | rules/feature-based.md |
| 按层分组 | MEDIUM | rules/layer-based.md |
| 框架结构 | MEDIUM | rules/framework-structure.md(仅在检测到受支持的框架时) |
工作流
第 1 步:检测项目类型
扫描项目指标,以确定合适的组织方式:
- 功能繁多的应用(SPA、Next.js/React,或任何由 UI 驱动的代码库)→ 按功能组织
- 服务 / API(Express、Fastify、Hono、Django、FastAPI、Go、Rails,……)→ 按层组织
- 单体仓库(
apps/+packages/,或工作区清单文件)→ 混合组织 - 现有结构 → 尊重并延续当前模式
仅在检测到其涵盖的框架时加载 rules/framework-structure.md(目前为 Next.js / Expo);否则,直接应用与语言无关的就近放置和分组规则。
第 2 步:审计
对照所有规则检查现有结构。
将每项发现报告为 path — 问题所在 → 修复方法,按 ### HIGH / ### MEDIUM / ### LOW 分组,并在末尾汇总每条规则的违规数量。
第 3 步:建议
根据项目类型和现有模式,建议新代码应放置的位置。默认将新代码放在唯一使用它的代码旁边;出现第二个使用者时,再将其移至共享位置。扩展项目已有的结构,而不要在旁边另建一套结构。
第 4 步:修复
针对每项违规应用修复:
- 如果目标目录不存在,先创建该目录(
mkdir -p <dest>)——目标目录缺失时,git mv会失败 - 使用
git mv将文件移至正确位置 - 更新依赖文件中的所有导入路径
- 移动文件后,确认不存在损坏的导入
评论
支持 Markdown