JPwise-Web 开发规范 - Claude Code

开发前检查清单（强制执行）

开发前必须检查：
□ 检查 src/views/ 中是否存在相似功能页面
□ 确认 src/components/ 中所需组件是否可用
□ 检查 src/api/ 中现有API调用模式
□ 确认 src/mixins/ 中相关混入的使用方式
□ 审查 src/utils/ 中相关工具函数

1. 代码质量规范

强制开发标准（严格禁止违反）

规范	要求	违反后果
组件创建	禁止创建已存在功能的新组件	代码审查不通过
混入使用	必须使用现有的页面混入	架构不一致
API规范	必须遵循现有API调用模式	接口调用失败
工具方法	必须使用现有工具函数	功能重复冗余
代码检查	提交前必须通过lint检查	CI构建失败

代码检查要求

• 提交代码前必须运行 npm run lint 通过代码检查
• 使用 npm run lint -- --fix 进行自动代码修复
• 必须在开发环境中进行充分测试验证
• 单元测试必须通过 npm run test:unit

详细代码检查要求请参考： 代码检查要求文档

2. 组件使用规范

组件复用原则

• 强制要求：必须使用项目封装的组件和工具方法
• 严格禁止：为已存在功能创建新的实现
• 优先级序：现有组件 > 扩展现有组件 > 创建新组件（需审批）

详细组件使用方法请参考： 组件库文档

Mixin使用规范

• 表单页面：必须使用表单混入 (formMixin)
• 列表页面：必须使用列表混入 (listMixin)
• 权限控制：必须使用权限混入 (btnPermission)
• 状态管理：正确使用 Vuex 的 mapState 和 mapGetters

混入使用详细说明请参考： 混入使用指南

3. API调用和文件组织规范

API调用和文件组织详细说明请参考： API工具指南

4. 审批制度和代码审查

必须审批的情况

以下情况必须获得技术负责人审批：

• 创建任何新组件（需先详细检查现有组件）
• 添加新的工具方法（需确认功能不存在）
• 修改核心混入或公共工具类
• 添加新的 npm 依赖包
• 更改现有组件的公共API
• 创建新的页面布局或交互模式

代码审查要求

• 代码提交前进行自我审查
• 确保代码符合项目既定的风格规范
• 验证功能完整性和边界条件处理
• 检查是否遵循了所有技术规范要求

5. 配置生成规范（强制执行）

⚠️ 配置生成强制要求

使用 /frontend:generate-config-json 命令时必须遵循：

规范	要求	违反后果
用户确认	必须征得用户对字段设计的明确确认	配置不符合需求
DDL生成	必须同时生成数据库DDL语句	数据库结构缺失
技术规范	必须遵循 .docs/config/standards/ 下的所有规范	配置质量不合格
交互流程	禁止跳过任何用户交互环节	配置生成失败

强制执行流程

每次配置生成必须包含以下步骤：

1. 📖 阅读技术规范 - 完整阅读相关技术文档
2. 🏗️ 设计字段结构 - 根据业务需求设计字段
3. ⏸️ 【强制暂停】用户确认 - 展示设计，等待用户明确回复
4. 🗄️ 【强制生成】DDL语句 - 生成数据库建表语句
5. 💾 再次确认 - 询问用户是否生成JSON配置
6. ⚙️ 生成配置 - 生成完整的JPWise配置文件

禁止行为

• ⛔ 禁止直接生成配置 - 必须先征得用户确认
• ⛔ 禁止跳过DDL生成 - DDL语句是强制输出内容
• ⛔ 禁止忽略技术规范 - 必须遵循所有标准和规则

相关文档

• generate-config-json 命令文档 - 详细的配置生成流程和命令使用说明
• 技术规范文档目录 - 所有技术规范文档

6. 技术架构规范

核心技术栈

• Vue 2.6.14 + Vue Router 3.6.5 + Vuex 3.6.2
• Element UI 2.15.10 组件库
• Vue CLI 4 构建工具
• Sass 样式预处理器
• Monaco Editor 代码编辑器
• ECharts 数据可视化

架构原则

• 保持技术栈的一致性和稳定性
• 优先使用现有技术方案解决问题
• 新技术引入需要经过充分评估和审批
• 确保向后兼容性和系统稳定性

7. 团队协作规范

协作原则

• 遵循统一的开发规范和流程
• 重要决策需要团队讨论和审批
• 知识共享和技术文档维护

---

核心理念：这是一个专注于维护和扩展现有功能的项目。始终优先使用现有的架构模式和组件，确保系统的稳定性和一致性。