# shaneholloman/codemapper architecture

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

- Interactive diagram: https://gitdiagram.com/shaneholloman/codemapper
- Repository: https://github.com/shaneholloman/codemapper

## Overview

##### Main Components

a) Core Processing Engine:
- Main modules from src/codemapper:
- main.py (entry point)
- docmap.py (documentation processing)
- config.py (configuration handling)
- utils.py (utility functions)

b) Input Sources (Left side):
- Local File System Input
- GitHub Repository Input
- Configuration Files (.gitignore support)

c) Processing Layers (Center):
- File Tree Analysis
- Content Processing
- Documentation Extraction
- Syntax Highlighting
- Git Integration

d) Output Generators (Right side):
- CodeMap Generator
- DocMap Generator
- AI Chat Integration Layer

##### Component Relationships

**Input Sources → Core Processing Engine → Output Generators**
- ↕
- Processing Layers

##### Specific Implementation Details

- Rectangles: Core components
- Rounded rectangles: Processing modules
- Hexagons: External integrations (AI Chat)
- Diamonds: Decision points

- Blue: Core processing components
- Green: Input handlers
- Orange: Output generators
- Purple: AI integration features
- Gray: Utility functions

##### Additional Elements

Supporting components:
- CI/CD Pipeline (.github/workflows)
- Testing Framework (tests directory)
- Documentation System (docs directory)
- Work in Progress Features (wip directory)

##### Implementation Notes

Use these visual cues:
- Double lines: API boundaries

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef input fill:#2ecc71,stroke:#27ae60,color:white
    classDef output fill:#e67e22,stroke:#d35400,color:white
    classDef ai fill:#9b59b6,stroke:#8e44ad,color:white
    classDef util fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef config fill:#f1c40f,stroke:#f39c12,color:black
    classDef test fill:#e74c3c,stroke:#c0392b,color:white
    classDef docs fill:#1abc9c,stroke:#16a085,color:white
    classDef wip fill:#34495e,stroke:#2c3e50,color:white

    %% Input Layer
    subgraph InputSources
        FS["Local File System"]:::input
        GH["GitHub Repository"]:::input
        CF["Configuration Files"]:::input
    end

    %% Core Processing
    subgraph CoreEngine
        MAIN["Main Entry Point"]:::core
        DOC["Documentation Processor"]:::core
        CONF["Configuration Handler"]:::core
        UTIL["Utility Functions"]:::core
    end

    %% Processing Layer
    subgraph ProcessingLayers
        FTA["File Tree Analysis"]:::core
        CP["Content Processing"]:::core
        DE["Documentation Extraction"]:::core
        SH["Syntax Highlighting"]:::core
        GI["Git Integration"]:::core
    end

    %% Output Layer
    subgraph OutputGenerators
        CG["CodeMap Generator"]:::output
        DG["DocMap Generator"]:::output
        AI["AI Chat Integration"]:::ai
    end

    %% Support Systems
    subgraph SupportSystems
        CICD["CI/CD Pipeline"]:::util
        TEST["Testing Framework"]:::test
        DOCS["Documentation System"]:::docs
        WIP["Work in Progress Features"]:::wip
    end

    %% Configuration
    subgraph ConfigSystem
        PC["Project Config"]:::config
        DEP["Dependencies"]:::config
        GC["Git Config"]:::config
    end

    %% Relationships
    InputSources --> CoreEngine
    CoreEngine --> ProcessingLayers
    ProcessingLayers --> OutputGenerators
    CoreEngine -.-> SupportSystems
    ConfigSystem --> CoreEngine

    %% Click Events
    click MAIN "https://github.com/shaneholloman/codemapper/blob/main/src/codemapper/main.py"
    click DOC "https://github.com/shaneholloman/codemapper/blob/main/src/codemapper/docmap.py"
    click CONF "https://github.com/shaneholloman/codemapper/blob/main/src/codemapper/config.py"
    click UTIL "https://github.com/shaneholloman/codemapper/blob/main/src/codemapper/utils.py"
    click CICD "https://github.com/shaneholloman/codemapper/tree/main/.github/workflows"
    click TEST "https://github.com/shaneholloman/codemapper/tree/main/tests"
    click DOCS "https://github.com/shaneholloman/codemapper/tree/main/docs"
    click WIP "https://github.com/shaneholloman/codemapper/tree/main/wip"
    click PC "https://github.com/shaneholloman/codemapper/blob/main/pyproject.toml"
    click DEP "https://github.com/shaneholloman/codemapper/blob/main/requirements.txt"
    click GC "https://github.com/shaneholloman/codemapper/blob/main/.gitignore"

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Input Handlers"]:::input
        L3["Output Generators"]:::output
        L4["AI Integration"]:::ai
        L5["Utility Functions"]:::util
        L6["Configuration"]:::config
        L7["Testing"]:::test
        L8["Documentation"]:::docs
        L9["Work in Progress"]:::wip
    end
```
