How azat-io/todoctor works
Main Components
a. Core Analysis Engine (Rust):
• Git Integration Module
• Comment Parser Module
• File System Handler
• Data Collection & Processing
b. Output Generation:
• HTML Report Generator
• JSON Generator
• CSV Generator
c. Preview/Visualization Layer (Svelte):
• Data Visualization Components
• UI Components
• Theme System
┌─────────────────────────────────────────┐
• CLI Interface │
• ┘
• ↓
┌─────────────────────────────────────────┐
• Core Analysis Engine │
• ┘
• ↓
┌─────────────────────────────────────────┐
• Report Generation Layer │
• ┘
Detailed Component Breakdown
a. Core Analysis Engine:
┌─────────────── Git Integration ──────────────┐
• Repository Validation │
• Blame Data Collection │
• File History Analysis │
• Modified Files Detection │
• ┬───────────────────────┘
• ↓
┌─────────────── Comment Analysis ────────────┐
• File Type Detection │
• TODO/FIXME Pattern Matching │
• Comment Extraction │
• ┬──────────────────────┘
• ↓
┌─────────────── Data Processing ────────────┐
• History Collection │
• Data Enrichment │
• Statistics Generation │
• ┘
Report Generation Layer
┌─────────────── Output Formats ──────────────┐
• ┌─────────┐ ┌────────┐ ┌─────────┐ │
• HTML │ │ JSON │ │ CSV │ │
• ┘ └────────┘ └─────────┘ │
• ┘
Visualization Components (Preview)
┌─────────────── UI Components ──────────────┐
• Graphs (Line, Doughnut) │
• Tables │
• Information Blocks │
• Theme System │
• ┘
Data Flow Indicators
• Input: Git repository → Core Engine
• Processing: Core Engine → Data Processing
• Output: Data Processing → Report Generation
• Visualization: Report Data → UI Components
Additional Elements
Annotations for:
• Supported file types
• Comment keywords
• Configuration options
• External dependencies (Git)