⚠️ ⚠️ This project is for personal use only: check the license for more information. ⚠️ ⚠️
This Software is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
Overview
EPSILON provides an intuitive interface for managing requirement documents directly within VS Code. It transforms technical XML requirement files into an easy-to-use rich text editor with specialized formatting and tracking capabilities.
Features
Rich Text Requirement Editor
User-Friendly Interface: Edit requirements with a modern, intuitive interface instead of raw XML
Rich Text Formatting: Add formatting such as bold, italic, lists, and headings to your requirement content
Automatic Change Tracking: Changes are automatically tracked with reference to ticket IDs from your Git branch names
Impact Analysis: Automatic updates to the impact analysis file to track which requirements are affected by changes
Requirements Explorer
Tree View Navigation: Easily navigate through your requirement files in a structured tree view
Quick Actions: Create new requirements or mark existing ones as deleted with simple context menu actions
Status Indication: Visual indicators for requirement status (applicable, deleted, etc.)
Version Control Integration
Git-Aware: Automatically extracts ticket IDs from branch names for change tracking
Change History: Maintains a detailed history of changes made to each requirement
Audit Trail: Every change is linked to a specific ticket ID for full traceability
Git Integration
For optimal use of the change tracking features:
Use branch names that include ticket IDs in the format feature/TICKET-123
The extension will automatically extract the ticket ID to track changes
Using EPSILON
Creating Requirements
Open the EPSILON view from the activity bar
Right-click on a folder and select "EPSILON: Create Requirement"
Enter the requirement ID when prompted
The new requirement file will be created and opened in the custom editor
Editing Requirements
Navigate to a requirement file in the EPSILON view
Click on the file to open it in the custom editor
Use the form fields and rich text editor to modify the requirement content
Press Ctrl+S or click Save to save your changes
Marking Requirements as Deleted
Right-click on a requirement file in the EPSILON view
Select "EPSILON: Delete Requirement"
The requirement will be marked as deleted (not physically removed)
Keyboard Shortcuts
The custom editor supports special keyboard shortcuts for rich text editing:
Ctrl+B: Bold text
Ctrl+I: Italic text
Ctrl+U: Underline text
Ctrl+S: Save requirement
Ctrl+Z: Undo (within editor)
Ctrl+Y: Redo (within editor)
System Requirements
Visual Studio Code version 1.99.0 or higher
Git extension for VS Code (automatically installed as a dependency)
