Appearance
开发规范
nexa 工程开发规范文档。所有规范具有强制性,AI 和开发者均须遵守。
规范索引
| 规范 | 适用范围 | 核心约束 |
|---|---|---|
| 组件库开发规范 | apps/* 所有组件库 | embedded prop、emit close、CSS Modules、peerDeps |
| gis-cesium 开发规范 | packages/gis-cesium | 流水线(识别→类型→实现→注册→示例)、禁止 any |
| tactics-sim-engine 开发规范 | products/tactics-sim-engine | 面板 wrapper 模式、Pinia store、服务层 |
| 测试规范 | 所有包 | 语义化断言、__tests__/ 目录、禁止硬等 |
| 命名规范 | 全局 | 网页 title、文件、变量、CSS、包命名 |
| 文档编写规范 | 全局 | 中文、JSDoc、TypeDoc、季度清理 |
| cesium-example 单案例迁移规范 | 旧案例迁移 | 单案例→方案审批→API/测试/案例/文档→人工验收 |
| 迁移 AI Prompt 模板 | 迁移 Agent | Skill 调用、审批指令与无 Skill 降级模板 |
规范优先级
当规范存在冲突时,按以下优先级:
- AGENTS.md — 工程宪法(最高优先级)
- 本文档目录 — 各领域细化规范
.codex/skills/、.claude/skills/、.codebuddy/skills/— 各 AI 平台的项目级执行入口- ESLint / TypeScript 配置 — 自动化检查
新规范提案
新规范或规范修改需覆盖:
text
[ ] 是否与 AGENTS.md 冲突?
[ ] 是否提供了正确/错误代码示例?
[ ] 是否有验收 checklist?
[ ] 是否明确了适用范围?