forked from datawhale/whale-town-end
docs:优化命名规范中的扁平化标准说明
- 将扁平化标准从3个文件调整为1-2个文件 - 明确单文件必须扁平化,双文件建议扁平化 - 3个文件保持独立文件夹结构 - 更新相关检查步骤和常见错误说明
This commit is contained in:
@@ -151,8 +151,9 @@
|
||||
5. **更新引用路径**:修改所有import语句
|
||||
|
||||
### 扁平化标准
|
||||
- **≤3个文件**:必须扁平化处理
|
||||
- **≥4个文件**:通常保持独立文件夹
|
||||
- **1个文件**:必须扁平化处理
|
||||
- **2个文件**:建议扁平化处理(除非是完整功能模块)
|
||||
- **≥3个文件**:保持独立文件夹
|
||||
- **完整功能模块**:即使文件较少也可保持独立(需特殊说明)
|
||||
|
||||
### 测试文件位置规范(重要)
|
||||
@@ -211,7 +212,7 @@ src/business/auth/
|
||||
|
||||
1. **只看文件夹名称,不检查内容**
|
||||
2. **凭印象判断,不使用工具获取准确数据**
|
||||
3. **遗漏≤3个文件文件夹的识别**
|
||||
3. **遗漏单文件或双文件文件夹的识别**
|
||||
4. **忽略测试文件夹扁平化**:认为tests文件夹是"标准结构"
|
||||
5. **🚨 错误地要求修改 NestJS 框架文件命名**:
|
||||
- ❌ 错误:要求将 `login.controller.ts` 改为 `login_controller.ts`(类型标识符不能用下划线)
|
||||
@@ -227,7 +228,7 @@ src/business/auth/
|
||||
1. **使用listDirectory工具检查目标文件夹结构**
|
||||
2. **逐个检查文件和文件夹命名是否符合规范**
|
||||
3. **统计每个文件夹的文件数量**
|
||||
4. **识别需要扁平化的文件夹(≤3个文件)**
|
||||
4. **识别需要扁平化的文件夹(1-2个文件)**
|
||||
5. **检查Core层模块命名是否正确**
|
||||
6. **执行必要的文件移动和重命名操作**
|
||||
7. **更新所有相关的import路径引用**
|
||||
|
||||
Reference in New Issue
Block a user