# githru/githru-vscode-ext architecture

> Architecture diagram of the GitHub repository githru/githru-vscode-ext, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/githru/githru-vscode-ext
- Repository: https://github.com/githru/githru-vscode-ext

## Overview

##### Main Components Identification
The project is structured as a monorepo with three main packages:
- analysis-engine: Core logic for Git commit analysis
- view: Frontend visualization components
- vscode: VSCode extension integration

##### VSCode Extension Host
- Extension Activation
- Command Registration
- Webview Management
- Git Operations

##### Analysis Engine
- Commit Parser
- CSM (Commit Semantic Model) Processor
- Queue Management
- GitHub Integration

##### View Layer
- React Components
- Data Visualization
- State Management
- IDE Communication Bridge

B. Component Relationships:

##### VSCode Extension → Git Repository
- Git log retrieval
- Repository metadata access

##### VSCode Extension ↔ Analysis Engine
- Raw commit data processing
- Semantic analysis results

##### VSCode Extension ↔ View Layer
- Webview communication
- Data updates
- User interactions

##### Analysis Engine → GitHub API
- User information
- Repository metadata

Use distinct visual elements:
- Blue rectangles: Core VSCode components
- Green hexagons: Analysis engine components
- Orange rectangles: View layer components
- Purple diamonds: External services (GitHub API)

D. Detailed Component Breakdown:

##### VSCode Extension (Blue)
- Extension Host
- Git Operations
- Webview Controller
- Settings Management

##### Analysis Engine (Green)
- Commit Parser
- Semantic Analyzer
- Queue Manager
- GitHub Integration

##### View Layer (Orange)
- Component Tree
- Cluster Visualization
- Statistics Views
- Temporal Filters
- Author Analysis
- State Management
- IDE Bridge

##### Data Flow Layers
- Raw Git Data
- Processed Commit Data
- Visualization Data
- User Interactions

Important Implementation Details to Highlight:

##### Communication Patterns
- Message passing between VSCode and Webview
- Data transformation points

##### State Management
- Data flow through the application
- Where state is maintained
- Update triggers

##### Extension Integration
- VSCode API integration points
- Command registration
- Extension activation flow

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph VSCode
        EH[Extension Host]
        CR[Command Registration]
        WM[Webview Management]
        GO[Git Operations]
        
        EH --> CR
        EH --> WM
        EH --> GO
    end

    subgraph "Analysis Engine"
        CP[Commit Parser]
        CSM[CSM Processor]
        QM[Queue Manager]
        GI[GitHub Integration]
        
        CP --> CSM
        CSM --> QM
        QM --> GI
    end

    subgraph "View Layer"
        RC[React Components]
        DV[Data Visualization]
        SM[State Management]
        IB[IDE Bridge]
        
        SM --> RC
        SM --> DV
        IB --> SM
    end

    subgraph "External Services"
        GH[("GitHub API")]
    end

    subgraph "Data Layer"
        RD[(Raw Git Data)]
        PD[(Processed Data)]
        VD[(Visualization Data)]
    end

    GO --> RD
    RD --> CP
    GI --> GH
    PD --> SM
    CSM --> PD
    WM --> IB
    VD --> DV

    %% Click events for component mapping
    click EH "https://github.com/githru/githru-vscode-ext/blob/main/packages/vscode/src/extension.ts"
    click CR "https://github.com/githru/githru-vscode-ext/blob/main/packages/vscode/src/commands.ts"
    click WM "https://github.com/githru/githru-vscode-ext/blob/main/packages/vscode/src/webview-loader.ts"
    click GO "https://github.com/githru/githru-vscode-ext/blob/main/packages/vscode/src/utils/git.util.ts"
    click CP "https://github.com/githru/githru-vscode-ext/blob/main/packages/analysis-engine/src/parser.ts"
    click CSM "https://github.com/githru/githru-vscode-ext/blob/main/packages/analysis-engine/src/csm.ts"
    click QM "https://github.com/githru/githru-vscode-ext/blob/main/packages/analysis-engine/src/queue.ts"
    click GI "https://github.com/githru/githru-vscode-ext/blob/main/packages/analysis-engine/src/pluginOctokit.ts"
    click RC "https://github.com/githru/githru-vscode-ext/tree/main/packages/view/src/components"
    click DV "https://github.com/githru/githru-vscode-ext/tree/main/packages/view/src/components/Statistics"
    click SM "https://github.com/githru/githru-vscode-ext/tree/main/packages/view/src/store"
    click IB "https://github.com/githru/githru-vscode-ext/blob/main/packages/view/src/ide/IDEPort.ts"

    classDef vscode fill:#2196F3,stroke:#1565C0,color:white
    classDef analysis fill:#4CAF50,stroke:#2E7D32,color:white
    classDef view fill:#FF9800,stroke:#EF6C00,color:white
    classDef external fill:#9C27B0,stroke:#6A1B9A,color:white
    classDef data fill:#90A4AE,stroke:#546E7A,color:white

    class EH,CR,WM,GO vscode
    class CP,CSM,QM,GI analysis
    class RC,DV,SM,IB view
    class GH external
    class RD,PD,VD data

    %% Legend
    subgraph Legend
        L1[VSCode Components]:::vscode
        L2[Analysis Components]:::analysis
        L3[View Components]:::view
        L4[("External Services")]:::external
        L5[(Data Stores)]:::data
    end
```
