lanyuanxiaoyao
7926514986
- 新增顶层 variables 段支持 string/number/boolean 字面量
- target 字符串字段支持 、、{...} 转义语法
- 变量解析优先级: variables -> process.env -> 默认值 -> 报错
- 完整引用保留原始类型，部分引用拼接为字符串
- 变量替换在 YAML 解析后、AJV 校验前执行
- 替换仅作用于 targets，跳过 id/type 字段
- target 新增必填 id 字段作为唯一标识，name 改为可选展示名称
- 数据库存储/API/前端全面迁移到 id 标识
- 统一 checker 运行时类型检查为 es-toolkit predicates
- 同步 delta specs 到主 specs，归档 config-variables 变更
52 lines
2.3 KiB
Markdown
52 lines
2.3 KiB
Markdown
## Purpose
|
||
|
||
定义 target 的 id/name 双字段标识体系：id 作为唯一标识符，name 作为可选展示名称。
|
||
|
||
## Requirements
|
||
|
||
### Requirement: target id 字段
|
||
每个 target SHALL 包含必填的 `id` 字段作为唯一标识符。`id` SHALL 符合 `[a-zA-Z0-9][a-zA-Z0-9_-]*` 命名规则。`id` MUST 在所有 targets 中全局唯一。`id` MUST NOT 参与变量替换。
|
||
|
||
#### Scenario: 合法 id
|
||
- **WHEN** target 配置 `id: "api-health"`
|
||
- **THEN** 系统 SHALL 使用该 id 作为 target 的唯一标识符
|
||
|
||
#### Scenario: id 包含下划线和连字符
|
||
- **WHEN** target 配置 `id: "db_check-01"`
|
||
- **THEN** 系统 SHALL 使用该 id 作为 target 的唯一标识符
|
||
|
||
#### Scenario: id 缺失报错
|
||
- **WHEN** target 未配置 `id` 字段
|
||
- **THEN** 系统 SHALL 以配置错误退出，提示该 target 缺少 id 字段
|
||
|
||
#### Scenario: id 为空字符串报错
|
||
- **WHEN** target 配置 `id: ""`
|
||
- **THEN** 系统 SHALL 以配置错误退出，提示 id 不能为空
|
||
|
||
#### Scenario: id 不合法报错
|
||
- **WHEN** target 配置 `id: "_invalid"` 或 `id: "-start"` 或 `id: "has space"`
|
||
- **THEN** 系统 SHALL 以配置错误退出，提示 id 不符合命名规则
|
||
|
||
#### Scenario: id 重复报错
|
||
- **WHEN** 两个 target 配置相同的 `id: "api-health"`
|
||
- **THEN** 系统 SHALL 以配置错误退出，提示 id 重复
|
||
|
||
### Requirement: target name 字段
|
||
每个 target SHALL 支持可选的 `name` 字段作为展示名称。`name` 缺省时 SHALL fallback 到 `id` 的值作为展示名称。`name` SHALL 支持变量替换。`name` MUST NOT 要求全局唯一。
|
||
|
||
#### Scenario: 配置 name
|
||
- **WHEN** target 配置 `id: "api-health"` 和 `name: "API 健康检查"`
|
||
- **THEN** 系统 SHALL 使用 "API 健康检查" 作为展示名称
|
||
|
||
#### Scenario: name 使用变量
|
||
- **WHEN** target 配置 `name: "${env} API 健康检查"` 且 variables 中 `env: "生产"`
|
||
- **THEN** 系统 SHALL 将展示名称解析为 "生产 API 健康检查"
|
||
|
||
#### Scenario: name 缺省 fallback 到 id
|
||
- **WHEN** target 配置 `id: "api-health"` 但未配置 `name`
|
||
- **THEN** 系统 SHALL 使用 "api-health" 作为展示名称
|
||
|
||
#### Scenario: 多个 target 使用相同 name
|
||
- **WHEN** 两个 target 配置不同 id 但相同 `name: "健康检查"`
|
||
- **THEN** 系统 SHALL 接受该配置，不报错（name 不要求全局唯一）
|