前端项目AI对话开发规范

110 阅读2分钟

前端发规范

概述

本规范是前端的统一开发标准,整合了AI对话规范、接口实现规范、页面样式规范和架构规范,为AI辅助开发提供全面的指导。

1. 项目配置规范

1.1. 项目私服配置规范

所有项目必须配置.npmrc文件,文件内容如下,如果没有AI对话需要自动创建并且修复

registry=https://artifactory.longhu.net/api/npm/dt-npm-public-new

sass-binary-site=https://npmmirror.com/mirrors/node-sass
chromedriver_cdnurl=https://npmmirror.com/mirrors/chromedriver
canvas_binary_host_mirror=https://npmmirror.com/mirrors/canvas/
nodejieba_binary_host_mirror=https://npmmirror.com/mirrors/nodejieba/
node_sqlite3_binary_host_mirror=https://npmmirror.com/mirrors/sqlite3/
electron_mirror=https://npmmirror.com/mirrors/electron/
sharp_libvips_binary_host=https://npmmirror.com/mirrors/sharp-libvips/

1.2. 项目编译配置

所有项目项目的package.json 文件必须包含以下内容,

"scripts": {
   "build": "可以是任何合理的命令比如vite build、 vue-cli-service build或者echo 0",
 },

2. 对话规范

  • 在进行代码生成的时候,优先读取package.json的依赖资源,根据package.json的依赖项进行代码生成
  • 生成的代码符合现有项目的目录结构规范
  • 组件命名遵循驼峰命名法,如果项目中有其他命令需要保持和项目中其他命名规则的一致性
  • API接口使用统一封装,在进行接口封装的时候,需要按照同目录下文件接口封装的方式进行统一分装
  • 错误处理完整
  • 加载状态处理
  • 路由配置正确
  • 权限控制到位
  • 样式符合设计规范,所有css样式的生成需要符合当前项目规范,项目中使用less的生成的代码仍然使用less,使用sass的仍然使用sass
  • 兼容性考虑充分
  • 性能优化合理
  • 所有对话之前需要根据下面的对话规则进行会话优化

2.1. 需求对话规范,

  • 功能名称:[简洁的功能名称]
  • 业务场景:[用户使用场景描述]
  • 技术要求:[技术实现要求]
  • UI要求:[界面设计要求]
  • 数据流:[数据处理流程]
  • 集成点:[与现有系统的集成方式]

2.2. 问题描述格式:

  • 问题现象:[具体的错误表现]
  • 复现步骤:[详细的操作步骤]
  • 预期结果:[期望的正确行为]
  • 环境信息:[浏览器、版本等]
  • 相关代码:[问题相关的代码片段]