AGILE TEAM
Skip to content

PC 端扩展规范

📝 作者
朱祥
朱祥·025877
平台室
杨晨誉
杨晨誉·409322
共享技术中心
仲于
仲于·026397
共享技术中心
胥庆玉
胥庆玉·026117
共享技术中心
马佳瑞
马佳瑞·409338
共享技术中心

说明

本版块收录 PC 端专属扩展规范(平台规范系列 12–14 条),是通用工程规范(01–11 条)之上、针对微服务平台架构和 @jhlc/common-core 组件体系的专项约定。

通用工程规范(01–11)请参阅 快速上手 — 规范约定


规范全景

前端编码规范共 14 条,由 @agile-team/wl-skills-kit 统一分发(.wl-skills/standards/ 目录),按职责分为 8 大类,是 AI 生成代码、规范审计与 CI 卡门的唯一基线。

分类规范编号覆盖范围
🛠️ 工具链01pnpm / ESLint / Prettier / Husky 前置检测
📁 工程结构02三文件分离、9 段式组织顺序、目录层级
📝 命名与注释03、04注释规范、基础编码(命名/缩进/字符串/大括号)
🔒 安全06v-html 防护、禁 eval、禁直连 axios、密钥管理
⚙️ 配置与协作05、07、08日志管控、VITE_ 环境变量、Git 分支与提交规范
🗄️ 数据层09、10TypeScript 类型约束、Pinia Store 结构
🖼️ 视图层11、14表单校验、布局容器(jh-drag-col / jh-drag-row,阻断式)
🧩 组件层12、13BaseTable + AGGrid、平台封装组件合规

规范列表

通用工程规范(01–11)

编号规范名称强制度摘要
01工具链规范🔴 阻断式.prettierrc.js / eslint.config.ts / .husky/ 三件套前置检测,未通过则 AI 暂停生成
02代码结构与顺序规范🔴 必遵四文件分离、<script setup> 9 段式组织顺序
03注释规范🟡 应遵文件头注释、JSDoc、杜绝显而易见的注释
04基础编码规范🟡 应遵命名/缩进/字符串/大括号/for...in 禁用等 13 条
05日志输出规范🟡 应遵console.* 残留管控,生产环境统一处理
06安全规范🔴 必遵v-html 需注释、禁 eval、禁直连 axios、密钥不入库
07配置管理规范🔴 必遵VITE_ 前缀环境变量、禁硬编码 http:// IP、baseURL 标准化
08Git 分支 & 提交规范🔴 阻断式Conventional Commits + commitlint,husky 自动拦截
09TypeScript 类型规范🟡 应遵严格模式、禁滥用 any、明确类型定义
10Pinia 状态管理规范🔴 必遵Store 模块划分、data.ts 内禁 import Store
11表单与校验规范🔴 必遵表单 validate / resetFields 必备、异步校验约定

PC 端扩展规范(12–14)

编号规范名称强制度摘要
12BaseTable 渲染与 AGGrid cid 唯一性规范🔴 必遵AGGrid 渲染模式、cid 全局唯一命名规则(base-36 时间戳)
13平台组件合规规范🔴 阻断式强制使用平台封装组件对照表,禁止直接使用 el-* 原生组件
14布局容器规范🔴 必遵 + 阻断式左右分栏统一 jh-drag-col、上下分栏统一 jh-drag-row,禁止手写 flex 模拟分栏拖拽(lint 命中即报错)

规范执行机制

14 条规范并非"贴在墙上的文档",而是通过三层强制机制落地,确保 AI 生成代码与人工提交代码均对齐基线。

第一层:AI 自动门控(生成阶段)

.wl-skills/standards/index.md 是规范的门控中枢。AI 在执行任何代码生成任务之前,按任务类型自动加载相关规范子集(而非全量加载,节省上下文):

任务类型 → 门控规则 → 加载哪几条规范
─────────────────────────────────────
page-codegen(页面生成)  → 02 + 04 + 06 + 09 + 12 + 13
api-contract(接口生成)  → 02 + 06 + 09
code-fix(自动修复)      → 全量(01–13)

单一数据源

14 条规范的唯一来源是 .wl-skills/standards/01 ~ 14,不接受"旧代码一直这么写"的辩解。规范升级时通过 wl-skills-kit update 增量覆盖。

第二层:validate CI 卡门(提交阶段)

wl-skills-kit 提供 validate 子命令,作为 CI 流水线的硬性卡门

bash
# 静态校验页面完整性(4 文件、AGGrid、cid、mock、api.md)
# + AST 语义级 K1~K19 检测(圈复杂度、分页边界、运行时边界等)
npx @agile-team/wl-skills-kit validate

# 单页面校验
npx @agile-team/wl-skills-kit validate-page <path>

CI 中校验未通过 → 构建中止,偏差代码无法进入主干。code-fix 完成修复后会强制复扫 validate,形成闭环。

第三层:husky / lint-staged 拦截(本地阶段)

提交前由 .husky/pre-commit 触发 lint-staged,对暂存区文件执行 ESLint + Prettier + commitlint,规范 08(Git 提交)在本地即被拦截,无需等待 CI。

本地 husky 拦截(08 提交规范)
    → CI validate 卡门(02/12/13 等)
        → convention-audit 体检(全量 01–13)

与 convention-audit Skill 的关系

convention-audit Skill 是 14 条规范的执行引擎:以 .wl-skills/standards/ 为唯一基线,扫描项目源码,输出偏差报告与组件提取建议,写入 reports/ 目录。

维度规范本身convention-audit
角色标准(应然)扫描器(实然 vs 应然)
产出.wl-skills/standards/*.mdreports/规范审查报告.md + reports/组件提取建议.md
动作静态文本发现偏差 + 给出整改建议,不自动修复
配合 Skillcode-fix(自动修 🟡🟢)· page-codegen(重生成 🔴)· template-extract(提取组件)

审计不修复,修复不审计

convention-audit 只负责发现偏差;实际修复由 code-fix Skill 完成(受控整改 🟡🟢 等级偏差),严重偏差(🔴)需人工介入或用 page-codegen 重新生成。

典型闭环page-codegen 生成代码 → 后置自动跑一次 convention-audit → 偏差入 reports/ → 触发 code-fix 整改 → 强制复扫 validate → ✅ 交付。


扩展说明

  • 编号延续:本版块规范编号从 12 起,接续快速上手中的 01–11,统一归属 @agile-team/wl-skills-kit 平台规范体系
  • 未来扩展:PC 端新增规范在此追加,编号顺延(14、15…);移动端 H5 独有规范见 移动端扩展规范

You may not distribute, modify, or sell this software without permission.