scene-capability-engine 3.0.0

package/docs/examples/add-export-command/requirements.md

@@ -0,0 +1,110 @@
+# Export Command - Requirements
+
+> Example Spec demonstrating CLI command development
+
+---
+
+**Version**: 1.42.0  
+**Last Updated**: 2026-02-11  
+**Spec Type**: Example - CLI Feature
+
+---
+
+## Overview
+
+This Spec demonstrates how to add a new CLI command to kse. We'll implement `kse export` command that exports Spec data in various formats (JSON, Markdown, HTML).
+
+**Learning Points:**
+- CLI command structure
+- Argument parsing
+- File I/O operations
+- Output formatting
+- Error handling in CLI
+
+---
+
+## User Stories
+
+### US-1: Export Spec as JSON
+**As a** developer  
+**I want to** export a Spec as JSON  
+**So that** I can process it programmatically
+
+**Acceptance Criteria:**
+- WHEN I run `kse export 01-00-feature --format json` THEN I get a JSON file
+- WHEN export succeeds THEN I see success message with file path
+- WHEN Spec doesn't exist THEN I see error message
+
+### US-2: Export Spec as Markdown
+**As a** developer  
+**I want to** export a Spec as single Markdown file  
+**So that** I can share it easily
+
+**Acceptance Criteria:**
+- WHEN I run `kse export 01-00-feature --format md` THEN I get a Markdown file
+- WHEN I don't specify format THEN Markdown is default
+- WHEN export succeeds THEN file contains all three Spec documents
+
+### US-3: Export Spec as HTML
+**As a** developer  
+**I want to** export a Spec as HTML  
+**So that** I can view it in a browser
+
+**Acceptance Criteria:**
+- WHEN I run `kse export 01-00-feature --format html` THEN I get an HTML file
+- WHEN I open HTML THEN it has proper styling
+- WHEN HTML includes code blocks THEN they have syntax highlighting
+
+---
+
+## Functional Requirements
+
+### FR-1: Command Interface
+```bash
+kse export <spec-name> [options]
+
+Options:
+  --format, -f    Output format (json|md|html) [default: md]
+  --output, -o    Output file path [default: auto-generated]
+  --include-meta  Include metadata in export [default: true]
+```
+
+### FR-2: JSON Export
+- Export structure: `{ name, requirements, design, tasks, metadata }`
+- Include file paths and timestamps
+- Pretty-print JSON (2-space indentation)
+
+### FR-3: Markdown Export
+- Combine requirements.md, design.md, tasks.md
+- Add table of contents
+- Add metadata header
+- Preserve formatting
+
+### FR-4: HTML Export
+- Convert Markdown to HTML
+- Add CSS styling
+- Add syntax highlighting for code blocks
+- Make it printable
+
+---
+
+## Non-Functional Requirements
+
+### NFR-1: Performance
+- Export completes in < 1 second for typical Spec
+- Handle large Specs (> 10MB) gracefully
+
+### NFR-2: Error Handling
+- Clear error messages for missing Specs
+- Validate format option
+- Handle file write errors
+
+### NFR-3: Usability
+- Intuitive command syntax
+- Helpful error messages
+- Progress indicator for large exports
+
+---
+
+**Version**: 1.42.0  
+**Last Updated**: 2026-02-11

package/docs/examples/add-export-command/tasks.md

@@ -0,0 +1,88 @@
+# Export Command - Tasks
+
+> Implementation plan for kse export command
+
+---
+
+**Version**: 1.42.0  
+**Last Updated**: 2026-02-11
+
+---
+
+## Phase 1: Core Infrastructure
+
+- [ ] 1.1 Create ExportService class
+  - Implement loadSpec() method
+  - Add error handling for missing files
+  - Write unit tests
+
+- [ ] 1.2 Create ExportCommand class
+  - Implement execute() method
+  - Add input validation
+  - Write unit tests
+
+---
+
+## Phase 2: Format Implementations
+
+- [ ] 2.1 Implement JSON export
+  - Create exportAsJSON() method
+  - Format Spec data as JSON
+  - Add pretty-printing
+  - Write unit tests
+
+- [ ] 2.2 Implement Markdown export
+  - Create exportAsMarkdown() method
+  - Combine all Spec documents
+  - Generate table of contents
+  - Write unit tests
+
+- [ ] 2.3 Implement HTML export
+  - Install marked library
+  - Create exportAsHTML() method
+  - Convert Markdown to HTML
+  - Add CSS styling
+  - Add syntax highlighting
+  - Write unit tests
+
+---
+
+## Phase 3: CLI Integration
+
+- [ ] 3.1 Register command in CLI
+  - Add command to bin/kiro-spec-engine.js
+  - Define options and arguments
+  - Wire up to ExportCommand
+
+- [ ] 3.2 Add output path handling
+  - Generate default output paths
+  - Validate custom output paths
+  - Create output directories if needed
+
+- [ ] 3.3 Add user feedback
+  - Show progress spinner
+  - Display success message with file path
+  - Show helpful error messages
+
+---
+
+## Phase 4: Testing
+
+- [ ] 4.1 Unit tests for ExportService
+- [ ] 4.2 Unit tests for ExportCommand
+- [ ] 4.3 Integration tests for CLI command
+- [ ] 4.4 Test all three export formats
+- [ ] 4.5 Test error scenarios
+
+---
+
+## Phase 5: Documentation
+
+- [ ] 5.1 Update command reference
+- [ ] 5.2 Add usage examples
+- [ ] 5.3 Update CHANGELOG
+
+---
+
+**Version**: 1.42.0  
+**Last Updated**: 2026-02-11