mirror of
https://github.com/Fission-AI/OpenSpec.git
synced 2026-11-07 09:14:38 +08:00
3f0ca3f6ce
* feat(tools): add Trae command adapter - Added Trae command adapter for generating `.trae/commands/opsx-<id>.md` files - Complete unit tests (9 test cases) and integration tests - Updated documentation and .gitignore - Fixed YAML escaping for carriage returns (\r) Co-Authored-By: Claude Code <noreply@anthropic.com> * fix: handle empty string in YAML escaping - Add explicit check for empty string in escapeYamlValue - Return quoted empty string '""' instead of unquoted empty scalar - Update test to verify empty string is properly quoted Co-Authored-By: Claude Code <noreply@anthropic.com> * fix: address PR review feedback for Trae adapter - Update docs/commands.md Trae entry to reflect generated opsx-* commands - Export traeAdapter from adapters/index.ts Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> * docs: align Trae command adapter docs --------- Co-authored-by: jjxyxsjr <jjxyxsjr@users.noreply.github.com> Co-authored-by: Claude Code <noreply@anthropic.com> Co-authored-by: Tabish Bidiwale <30385142+TabishB@users.noreply.github.com> Co-authored-by: TabishB <tabishbidiwale@gmail.com>
103 lines
3.9 KiB
Markdown
103 lines
3.9 KiB
Markdown
# command-generation Specification
|
|
|
|
## Purpose
|
|
Define tool-agnostic command content and adapter contracts for generating tool-specific OpenSpec command files.
|
|
|
|
## Requirements
|
|
### Requirement: CommandContent interface
|
|
|
|
The system SHALL define a tool-agnostic `CommandContent` interface for command data.
|
|
|
|
#### Scenario: CommandContent structure
|
|
|
|
- **WHEN** defining a command to generate
|
|
- **THEN** `CommandContent` SHALL include:
|
|
- `id`: string identifier (e.g., 'explore', 'apply')
|
|
- `name`: human-readable name (e.g., 'OpenSpec Explore')
|
|
- `description`: brief description of command purpose
|
|
- `category`: grouping category (e.g., 'OpenSpec')
|
|
- `tags`: array of tag strings
|
|
- `body`: the command instruction content
|
|
|
|
### Requirement: ToolCommandAdapter interface
|
|
|
|
The system SHALL define a `ToolCommandAdapter` interface for per-tool formatting.
|
|
|
|
#### Scenario: Adapter interface structure
|
|
|
|
- **WHEN** implementing a tool adapter
|
|
- **THEN** `ToolCommandAdapter` SHALL require:
|
|
- `toolId`: string identifier matching `AIToolOption.value`
|
|
- `getFilePath(commandId: string)`: returns file path for command (relative from project root, or absolute for global-scoped tools like Codex)
|
|
- `formatFile(content: CommandContent)`: returns complete file content with frontmatter
|
|
|
|
#### Scenario: Claude adapter formatting
|
|
|
|
- **WHEN** formatting a command for Claude Code
|
|
- **THEN** the adapter SHALL output YAML frontmatter with `name`, `description`, `category`, `tags` fields
|
|
- **AND** file path SHALL follow pattern `.claude/commands/opsx/<id>.md`
|
|
|
|
#### Scenario: Cursor adapter formatting
|
|
|
|
- **WHEN** formatting a command for Cursor
|
|
- **THEN** the adapter SHALL output YAML frontmatter with `name` as `/opsx-<id>`, `id`, `category`, `description` fields
|
|
- **AND** file path SHALL follow pattern `.cursor/commands/opsx-<id>.md`
|
|
|
|
#### Scenario: Windsurf adapter formatting
|
|
|
|
- **WHEN** formatting a command for Windsurf
|
|
- **THEN** the adapter SHALL output YAML frontmatter with `name`, `description`, `category`, `tags` fields
|
|
- **AND** file path SHALL follow pattern `.windsurf/workflows/opsx-<id>.md`
|
|
|
|
#### Scenario: Trae adapter formatting
|
|
|
|
- **WHEN** formatting a command for Trae
|
|
- **THEN** the adapter SHALL output YAML frontmatter with `name` and `description` fields
|
|
- **AND** file path SHALL follow pattern `.trae/commands/opsx-<id>.md`
|
|
|
|
### Requirement: Command generator function
|
|
|
|
The system SHALL provide a `generateCommand` function that combines content with adapter.
|
|
|
|
#### Scenario: Generate command file
|
|
|
|
- **WHEN** calling `generateCommand(content, adapter)`
|
|
- **THEN** it SHALL return an object with:
|
|
- `path`: the file path from `adapter.getFilePath(content.id)`
|
|
- `fileContent`: the formatted content from `adapter.formatFile(content)`
|
|
|
|
#### Scenario: Generate multiple commands
|
|
|
|
- **WHEN** generating all opsx commands for a tool
|
|
- **THEN** the system SHALL iterate over command contents and generate each using the tool's adapter
|
|
|
|
### Requirement: CommandAdapterRegistry
|
|
|
|
The system SHALL provide a registry for looking up tool adapters.
|
|
|
|
#### Scenario: Get adapter by tool ID
|
|
|
|
- **WHEN** calling `CommandAdapterRegistry.get('cursor')`
|
|
- **THEN** it SHALL return the Cursor adapter or undefined if not registered
|
|
|
|
#### Scenario: Get all adapters
|
|
|
|
- **WHEN** calling `CommandAdapterRegistry.getAll()`
|
|
- **THEN** it SHALL return array of all registered adapters
|
|
|
|
#### Scenario: Adapter not found
|
|
|
|
- **WHEN** looking up an adapter for unregistered tool
|
|
- **THEN** `CommandAdapterRegistry.get()` SHALL return undefined
|
|
- **AND** caller SHALL handle missing adapter appropriately
|
|
|
|
### Requirement: Shared command body content
|
|
|
|
The body content of commands SHALL be shared across all tools.
|
|
|
|
#### Scenario: Same instructions across tools
|
|
|
|
- **WHEN** generating the 'explore' command for Claude and Cursor
|
|
- **THEN** both SHALL use the same `body` content
|
|
- **AND** only the frontmatter and file path SHALL differ
|