名称:ears-convert 描述:“将规范转换为EARS格式或从EARS格式转换。” 参数提示:“<源文件> [–to ears|canonical|prose|gherkin]” 允许工具:Read, Glob, Grep, Write, Edit, Skill, Task
EARS格式转换
在EARS格式和其他格式之间转换规范。
支持的转换
| 从 | 到 | 描述 |
|---|---|---|
| Prose | EARS | 自然语言到结构化EARS |
| EARS | Prose | EARS到可读自然语言 |
| EARS | Gherkin | EARS到Given/When/Then场景 |
| Gherkin | EARS | Gherkin场景到EARS需求 |
| EARS | Canonical | EARS列表到规范规范 |
| Canonical | EARS | 从规范中提取EARS需求 |
工作流程
-
加载源
- 读取源文件
- 检测当前格式
-
分析内容
- 解析需求或场景
- 识别模式和结构
-
转换
- 生成
spec-converter ears代理 - 转换到目标格式
- 保持语义意义
- 生成
-
验证
- 检查目标格式合规性
- 验证内容保留
-
输出
- 写入文件或显示
参数
$1- 源文件路径--to- 目标格式:ears, canonical, prose, gherkin--output- 输出文件路径(可选)
示例
# Prose 到 EARS
/spec-driven-development:ears-convert requirements.txt --to ears
# EARS 到 Gherkin
/spec-driven-development:ears-convert ears-requirements.md --to gherkin
# EARS 到可读 prose
/spec-driven-development:ears-convert spec.md --to prose
# 指定输出
/spec-driven-development:ears-convert input.md --to ears --output output.md
转换示例
Prose → EARS
输入 (Prose):
用户应能使用电子邮件和密码登录。
系统需要在授予访问权限前验证凭据。
输出 (EARS):
## FR-1: 用户认证
当用户提交登录凭据时,
系统应验证电子邮件和密码
并在凭据有效时授予访问权限。
EARS → Gherkin
输入 (EARS):
当用户提交有效凭据时,
系统应创建会话令牌。
输出 (Gherkin):
场景:成功登录创建会话
给定一个拥有有效凭据的用户
当用户提交登录表单
那么创建一个会话令牌
并且用户被重定向到仪表板
EARS → Prose
输入 (EARS):
当用户被认证时,
系统应在页眉显示用户的姓名。
输出 (Prose):
当用户登录时,系统在页面页眉显示其姓名。
这确保用户可以确认他们正在使用正确的账户。
模式保留
转换器保留EARS模式语义:
| EARS模式 | 保留为 |
|---|---|
| WHEN…SHALL | Gherkin When…Then |
| WHILE…SHALL | Gherkin Given (状态)…Then |
| IF…THEN…SHALL | Gherkin 错误场景 |
| WHERE…SHALL | Gherkin @tag 场景 |
相关命令
/spec-driven-development:ears-author- 创建EARS需求/spec-driven-development:gherkin-convert- Gherkin转换/spec-driven-development:convert- 通用格式转换