结构
此技能指导前端代码在仓库中的存放位置:文件夹约定、命名规则以及如何判断文件是否放错位置。这些约定随代码库演变,因此权威列表位于 reference.md 中——在放置文件之前请先阅读它。
步骤
- 询问文件是什么,而不是它适合放在哪里。 组件、钩子、工具函数、测试、资源、配置。类型决定了放置位置;类型是 reference.md 中约定的前置词。 完成条件:用一个词说明文件类型。
- 按规则放置,每次移动一整个单元。 组件与其测试、故事和样式一起移动——绝不能单独移动组件。 完成条件:放置位置完全符合规则;任何不符合命名规范的内容必须在运行结束时列出并说明原因。
- 与相邻文件确认命名。 名称与同级文件及整体约定一致:单复数、分隔符、大小写。 完成条件:目录列表看起来统一;无需重命名即可融入。
参考
- reference.md —— 放置规则和命名约定。当仓库布局稳定后更新该文件;它是唯一的事实来源,其他地方声明的约定都是此文件的近似位置。
- 当两条规则看似冲突时,更具体的那条规则优先,并报告冲突以便纠正规则。