Documentation
README
字段映射安全规范
触发场景
- 重构表格列定义(dataIndex、columns)
- 重构枚举类型映射(typeMap、statusMap)
- 重构数据转换逻辑(render 函数、formatter)
- 类型定义中有多个相似字段(changedAt vs createdAt)
核心原则
不要根据类型定义推测字段名,必须查看原始代码的实际使用
检查清单
1. 字段名验证
- 查看原始代码的 dataIndex
- 查看后端 API 返回的实际字段名
- 优先使用必填字段,避免可选字段
- 注意字段名的细微差异(changedAt vs createdAt、changeType vs operationType)
2. 枚举映射验证
- 对照原始代码,逐个检查枚举值
- 确保映射完整(不遗漏任何枚举值)
- 检查枚举值的拼写(UPLOAD vs Upload)
- 检查枚举值的颜色、文本是否一致
3. 运行时测试
- TypeScript 类型检查通过(必要但不充分)
- 在实际环境中测试功能
- 检查是否显示 "Invalid Date"、"undefined"、空白
- 检查枚举值是否都有对应的映射
常见陷阱
陷阱 1: 类型定义有歧义
场景:类型定义中有多个相似字段
This is the opening of the README. Read the full README on GitHub.