# codesankalp/dotfiles architecture

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

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

## Overview

##### Main Components

a. Configuration Groups:
- Shell Environment (ZSH)
- Terminal Emulator (Alacritty)
- Text Editor (Neovim)
- Version Control (Git)
- Terminal Multiplexer (Tmux)
- Development Tools (WakaTime)

b. Script Utilities:
- Setup Scripts
- Cloud Tools (GCloud SSH)

**Core Components:**
- Configuration Manager (dotfiles)
- Config Directory
- Scripts Directory

##### Specific Component Details

Neovim Configuration Cluster:
- Relationship between init.lua and the lua/ directory
- Plugin management (lazy.nvim)
- LSP configuration flow
- Formatting tools integration

Shell Environment Cluster:
- ZSH configuration hierarchy
- Aliases integration
- P10k (Powerlevel10k) theming
- Environment variables flow

##### Important Elements to Emphasize

a. Setup Flow:
- Setup_dotfiles script's role in system initialization
- Symlink relationships to home directory

b. Tool Integration:
- How WakaTime integrates across different tools
- Git configuration inheritance

Create distinct sections for:

##### Technical Details

- Configuration file formats (.lua, .zsh, .toml)
- Key plugin dependencies
- Script execution paths
- System requirements or prerequisites

Remember to include a note about the system's extensibility and how new configurations can be added to the existing structure. This will help future maintainers understand how to properly expand the system.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Legend
        L1[Config File]
        L2([Script])
        L3[(Plugin)]
        style L1 fill:#d4e6ff
        style L2 fill:#ffe0cc
        style L3 fill:#d4ffcc
    end

    subgraph Core["Configuration Manager"]
        Config["Config Directory"]
        Scripts["Scripts Directory"]
        click Config "https://github.com/codesankalp/dotfiles/tree/main/config/"
        click Scripts "https://github.com/codesankalp/dotfiles/tree/main/scripts/"
    end

    subgraph Shell["Shell Environment"]
        Zshrc["ZSH Config"]
        Aliases["Aliases"]
        P10k["Powerlevel10k"]
        click Zshrc "https://github.com/codesankalp/dotfiles/blob/main/config/zsh/.zshrc"
        click Aliases "https://github.com/codesankalp/dotfiles/blob/main/config/zsh/aliases.zsh"
        click P10k "https://github.com/codesankalp/dotfiles/blob/main/config/zsh/.p10k.zsh"
    end

    subgraph Terminal["Terminal Environment"]
        Alacritty["Alacritty Config"]
        Tmux["Tmux Config"]
        click Alacritty "https://github.com/codesankalp/dotfiles/blob/main/config/alacritty/alacritty.toml"
        click Tmux "https://github.com/codesankalp/dotfiles/blob/main/config/tmux/.tmux.conf.local"
    end

    subgraph Editor["Text Editor (Neovim)"]
        Init["init.lua"]
        Options["Options"]
        Mappings["Key Mappings"]
        subgraph Plugins
            Lazy["Lazy.nvim"]
            LSP["LSP Config"]
            Conform["Formatting"]
        end
        click Init "https://github.com/codesankalp/dotfiles/blob/main/config/nvim/init.lua"
        click Options "https://github.com/codesankalp/dotfiles/blob/main/config/nvim/lua/options.lua"
        click Mappings "https://github.com/codesankalp/dotfiles/blob/main/config/nvim/lua/mappings.lua"
        click Lazy "https://github.com/codesankalp/dotfiles/blob/main/config/nvim/lua/configs/lazy.lua"
        click LSP "https://github.com/codesankalp/dotfiles/blob/main/config/nvim/lua/configs/lspconfig.lua"
        click Conform "https://github.com/codesankalp/dotfiles/blob/main/config/nvim/lua/configs/conform.lua"
    end

    subgraph Tools["Development Tools"]
        Git["Git Config"]
        WakaTime["WakaTime Config"]
        click Git "https://github.com/codesankalp/dotfiles/blob/main/config/git/.gitconfig"
        click WakaTime "https://github.com/codesankalp/dotfiles/blob/main/config/wakatime/.wakatime.cfg"
    end

    subgraph Utils["Script Utilities"]
        Setup([Setup Dotfiles])
        GCloud([GCloud SSH])
        click Setup "https://github.com/codesankalp/dotfiles/tree/main/scripts/setup_dotfiles"
        click GCloud "https://github.com/codesankalp/dotfiles/tree/main/scripts/gcloud_ssh"
    end

    Config --> Shell
    Config --> Terminal
    Config --> Editor
    Config --> Tools
    Scripts --> Utils

    Setup --> Config
    Setup --> Scripts

    Init --> Options
    Init --> Mappings
    Init --> Plugins
    Lazy --> LSP
    Lazy --> Conform

    WakaTime -.-> Editor
    WakaTime -.-> Shell

    style Config fill:#d4e6ff
    style Scripts fill:#ffe0cc
    style Setup fill:#ffe0cc
    style GCloud fill:#ffe0cc
    style Lazy fill:#d4ffcc
    style LSP fill:#d4ffcc
    style Conform fill:#d4ffcc
```
