# phantaszm/dotfiles architecture

> Architecture diagram of the GitHub repository phantaszm/dotfiles, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/phantaszm/dotfiles
- Repository: https://github.com/phantaszm/dotfiles

## Overview

##### Main Component Categories

a) Shell Environment
- Fish Shell Configuration
- Custom Functions and Completions
- Environment Variables

b) Editor Configuration
- Neovim (Two Variants)
- NvChad Custom Configuration
- Scratch Configuration
- Vim Configuration

c) Terminal Utilities
- Tmux (Terminal Multiplexer)
- Bat (Enhanced Cat)
- Silicon (Code Screenshot Tool)

##### Specific Implementation Details

**[User Interface Layer]**

- Neovim      |  |     Tmux      |  |    Terminal   |
- (Two Configs)  |  |               |  |    Utilities  |

- ↑                 ↑                   ↑

**[Configuration Layer]**

- Fish Shell    |←-|   Base16      |--|    Themes     |
- Environment   |  |   Theming     |  |    & Styles   |

- ↑                 ↑                   ↑

**[Core Configuration Files]**

- Dotfiles     |--|   Plugin      |--|    Script     |
- Repository   |  |   Managers    |  |    Utilities  |

##### Important Details to Highlight

- Shell configurations (Fish): Blue
- Editor configurations (Neovim/Vim): Green
- Terminal utilities: Orange
- Theming and styling: Purple

- Plugin management systems
- Configuration file locations
- Integration points between components

##### Notes for Implementation

- Clear separation between different tool configurations
- Shared resources and common configurations
- Initialization order where relevant

Remember to maintain a balance between detail and clarity, focusing on the architectural relationships rather than individual configuration settings.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "User Interface Layer"
        NV["Neovim Editor"]
        TM["Tmux Multiplexer"]
        TU["Terminal Utilities"]
    end

    subgraph "Shell Environment"
        FS["Fish Shell"]
        FF["Fish Functions"]
        FC["Fish Completions"]
        FD["Fish Config.d"]
    end

    subgraph "Editor Configurations"
        NC["NvChad Custom"]
        NS["Nvim Scratch"]
        VC["Vim Config"]
    end

    subgraph "Terminal Tools"
        BAT["Bat Utility"]
        SIL["Silicon Tool"]
    end

    subgraph "Plugin Management"
        FPM["Fisher Plugin Manager"]
        TPM["Tmux Plugin Manager"]
    end

    subgraph "Theming System"
        B16["Base16 Shell"]
        BT["Bat Theme"]
        ST["Silicon Theme"]
    end

    subgraph "Installation"
        JIT["JIT Installer"]
    end

    %% Relationships
    FS --> FF
    FS --> FC
    FS --> FD
    NV --> NC
    NV --> NS
    NV --> VC
    TM --> TPM
    FS --> FPM
    B16 --> FS
    B16 --> BAT
    B16 --> SIL
    JIT --> FS
    JIT --> NV
    JIT --> TM

    %% Click Events
    click FS "https://github.com/phantaszm/dotfiles/tree/main/.config/fish/"
    click FF "https://github.com/phantaszm/dotfiles/tree/main/.config/fish/functions/"
    click FC "https://github.com/phantaszm/dotfiles/tree/main/.config/fish/completions/"
    click FD "https://github.com/phantaszm/dotfiles/tree/main/.config/fish/conf.d/"
    click NC "https://github.com/phantaszm/dotfiles/tree/main/.config/nvchad-custom/"
    click NS "https://github.com/phantaszm/dotfiles/tree/main/.config/nvim-scratch/"
    click VC "https://github.com/phantaszm/dotfiles/blob/main/.vimrc"
    click TM "https://github.com/phantaszm/dotfiles/blob/main/.config/tmux/tmux.conf"
    click BAT "https://github.com/phantaszm/dotfiles/tree/main/.config/bat/"
    click SIL "https://github.com/phantaszm/dotfiles/tree/main/.config/silicon/"
    click FPM "https://github.com/phantaszm/dotfiles/blob/main/.config/fish/functions/fisher.fish"
    click TPM "https://github.com/phantaszm/dotfiles/tree/main/.config/tmux/plugins/tpm"
    click B16 "https://github.com/phantaszm/dotfiles/tree/main/.config/base16-shell/"
    click BT "https://github.com/phantaszm/dotfiles/blob/main/.config/bat/themes/base16-tomorrow-night.tmTheme"
    click ST "https://github.com/phantaszm/dotfiles/blob/main/.config/silicon/themes/base16-tomorrow-night.tmTheme"
    click JIT "https://github.com/phantaszm/dotfiles/blob/main/.bin/jit-install.sh"

    %% Styling
    classDef shell fill:#3498db
    classDef editor fill:#2ecc71
    classDef utility fill:#e67e22
    classDef theme fill:#9b59b6
    classDef installer fill:#e74c3c

    class FS,FF,FC,FD shell
    class NV,NC,NS,VC editor
    class TM,BAT,SIL,TU utility
    class B16,BT,ST theme
    class JIT installer
    class FPM,TPM utility
```
