name: openspec-sync-specs description: 将变更中的增量规范同步到主规范。当用户想要用增量规范中的更改更新主规范,而不归档变更时使用。 license: MIT compatibility: Requires openspec CLI. metadata: author: openspec version: "1.0"
将变更中的增量规范同步到主规范。
这是一个 Agent 驱动 的操作 - 你将阅读增量规范并直接编辑主规范以应用更改。这允许智能合并(例如,添加一个场景而不复制整个需求)。
输入:可选择指定变更名称。如果省略,检查是否可以从对话上下文中推断。如果模糊或不明确,必须提示可用的变更。
步骤
运行 openspec list --json 获取可用变更。使用 AskUserQuestion 工具 让用户选择。
显示具有增量规范(在 specs/ 目录下)的变更。
重要:不要猜测或自动选择变更。始终让用户选择。
在 openspec/changes/<name>/specs/*/spec.md 中查找增量规范文件。
每个增量规范文件包含如下部分:
## ADDED Requirements - 要添加的新需求## MODIFIED Requirements - 对现有需求的更改## REMOVED Requirements - 要删除的需求## RENAMED Requirements - 要重命名的需求(FROM:/TO: 格式)如果未找到增量规范,通知用户并停止。
对于在 openspec/changes/<name>/specs/<capability>/spec.md 具有增量规范的每个 capability:
a. 阅读增量规范 以了解预期的更改
b. 阅读主规范 openspec/specs/<capability>/spec.md(可能还不存在)
c. 智能应用更改:
**ADDED Requirements:**
- 如果主规范中不存在需求 → 添加它
- 如果需求已存在 → 更新它以匹配(视为隐式 MODIFIED)
**MODIFIED Requirements:**
- 在主规范中找到需求
- 应用更改 - 这可能是:
- 添加新场景(不需要复制现有的)
- 修改现有场景
- 更改需求描述
- 保留未在增量中提及的场景/内容
**REMOVED Requirements:**
- 从主规范中删除整个需求块
**RENAMED Requirements:**
- 找到 FROM 需求,重命名为 TO
d. 创建新主规范 如果 capability 尚不存在:
- 创建 `openspec/specs/<capability>/spec.md`
- 添加 Purpose 部分(可以简短,标记为 TBD)
- 添加 Requirements 部分包含 ADDED requirements
应用所有更改后,总结:
增量规范格式参考
## ADDED Requirements
### Requirement: New Feature
The system SHALL do something new.
#### Scenario: Basic case
- **WHEN** user does X
- **THEN** system does Y
## MODIFIED Requirements
### Requirement: Existing Feature
#### Scenario: New scenario to add
- **WHEN** user does A
- **THEN** system does B
## REMOVED Requirements
### Requirement: Deprecated Feature
## RENAMED Requirements
- FROM: `### Requirement: Old Name`
- TO: `### Requirement: New Name`
关键原则:智能合并
与程序化合并不同,你可以应用 部分更新:
成功时的输出
## 规范已同步:<change-name>
已更新主规范:
**<capability-1>**:
- 添加需求:"New Feature"
- 修改需求:"Existing Feature"(添加了 1 个场景)
**<capability-2>**:
- 创建了新规范文件
- 添加需求:"Another Feature"
主规范现已更新。变更保持活跃 - 在实施完成后归档。
护栏