How eglavin/fork-version works
Main Components
a. Core Processing Components:
• Version Management System
• Changelog Generator
• File Management System
• Git Integration Layer
• Configuration Management
b. Input/Output Components:
• CLI Interface
• File System Interface
• Git Repository Interface
┌─ User Interface Layer ─────────────────────┐
• CLI Interface │
• ┬───────────────────────┘
• ↓
┌─ Configuration Layer ───────────────────────┐
• Config Manager │
• File Config │
• CLI Arguments │
• Default Settings │
• ┬───────────────────────┘
• ↓
┌─ Core Processing Layer ──────────────────────┐
• ┌─────────────┐ ┌──────────┐ ┌──────────┐ │
• Version │ │Changelog │ │ File │ │
• Processor │←→│Generator │←→│ Manager │ │
• ┘ └──────────┘ └──────────┘ │
• ┬───────────────────────┘
• ↓
┌─ Integration Layer ────────────────────────┐
• Git Operations │
• File System Operations │
• ┘
Component Details
a. User Interface Layer:
• CLI command processing
• Configuration file parsing
• Help and version information handling
b. Configuration Layer:
• Config merging from multiple sources
• Validation and schema checking
• Default configuration handling
c. Core Processing Layer:
• Version Management:
• Version detection
• Version bumping
• Pre-release handling
• Changelog Generation:
• Commit parsing
• Conventional commits processing
• Markdown generation
• File Management:
• File type detection
• Version updating in different file formats
• File state tracking
d. Integration Layer:
• Git operations:
• Commit creation
• Tag management
• Repository state checking
• File system operations:
• File reading/writing
• Glob pattern matching
• Path resolution
Data Flow Indicators
• Command flow from CLI to processing components
• File reading/writing operations
• Git operation flow
• Configuration distribution
• Version information flow
• Changelog generation process
Additional Elements
Include:
• Version flow indicators
• File type support indicators
• Configuration source indicators
• Error handling paths
• Optional operation paths (e.g., dry run mode)
Notes
Annotations for:
• Supported file types
• Configuration options
• CLI arguments
• Exit codes
• Pre-release handling
• Version determination logic
Remember to emphasize:
• The modular nature of the system
• The clear separation of concerns
• The extensibility points
• The configuration flexibility
• The error handling paths
• The optional feature paths
This will provide a clear understanding of how Fork-Version processes version management tasks while maintaining its focus on versioning and changelog generation aspects.