# marlonrichert/zsh-autocomplete architecture

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

- Interactive diagram: https://gitdiagram.com/marlonrichert/zsh-autocomplete
- Repository: https://github.com/marlonrichert/zsh-autocomplete

## Overview

##### Main Components Structure

a. Core Plugin Components:
- Initialize a central rectangle labeled "zsh-autocomplete.plugin.zsh" (entry point)
- Create three main subsystems:
- Initialization System (Functions/Init/)
- Completion System (Completions/)
- Widget System (Functions/Widgets/)

b. Utility Layer:
- Connections to both initialization and widget systems

##### Component Relationships

a. Initialization Flow:
- .autocomplete__compinit (completion system initialization)
- .autocomplete__config (configuration management)
- .autocomplete__key-bindings (keyboard shortcuts setup)
- .autocomplete__widgets (widget initialization)
- .autocomplete__recent-dirs (directory history management)

b. Completion System:
- _autocomplete__command
- _autocomplete__recent_paths
- _autocomplete__unambiguous

c. Widget System:
- Related widgets:
- Complete-word widgets
- History search widgets
- Navigation widgets (up/down line)
- Interaction with Zsh's ZLE (Zsh Line Editor)

##### External Interactions

Create interfaces showing:
- Zsh Shell Integration
- User Input Handling
- Terminal Interface
- File System (for recent paths)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Legend
        L1[Rectangle: Main Component]
        L2([Rounded: UI Element])
        L3{{Hexagon: External System}}
        L4[(Database/Storage)]
        style L1 fill:#a4c2f4
        style L2 fill:#b6d7a8
        style L3 fill:#f9cb9c
        style L4 fill:#d5a6bd
    end

    subgraph Core["Core Plugin"]
        Entry["zsh-autocomplete.plugin.zsh"]:::core
        click Entry "https://github.com/marlonrichert/zsh-autocomplete/blob/main/zsh-autocomplete.plugin.zsh"
    end

    subgraph Init["Initialization System"]
        Config["Configuration Management"]:::init
        KeyBind["Keyboard Shortcuts"]:::init
        CompInit["Completion System Init"]:::init
        WidgetInit["Widget Initialization"]:::init
        RecentDirs["Recent Directories"]:::init
        Async["Async Processing"]:::init

        click Config "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Init/.autocomplete__config"
        click KeyBind "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Init/.autocomplete__key-bindings"
        click CompInit "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Init/.autocomplete__compinit"
        click WidgetInit "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Init/.autocomplete__widgets"
        click RecentDirs "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Init/.autocomplete__recent-dirs"
        click Async "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Init/.autocomplete__async"
    end

    subgraph Comp["Completion System"]
        CmdComp["Command Completion"]:::comp
        RecentPaths["Recent Paths Handler"]:::comp
        Unambiguous["Unambiguous Completion"]:::comp
        HistLines["History Lines"]:::comp

        click CmdComp "https://github.com/marlonrichert/zsh-autocomplete/tree/main/Completions/_autocomplete__command"
        click RecentPaths "https://github.com/marlonrichert/zsh-autocomplete/tree/main/Completions/_autocomplete__recent_paths"
        click Unambiguous "https://github.com/marlonrichert/zsh-autocomplete/tree/main/Completions/_autocomplete__unambiguous"
        click HistLines "https://github.com/marlonrichert/zsh-autocomplete/tree/main/Completions/_autocomplete__history_lines"
    end

    subgraph Widget["Widget System"]
        CompleteWord["Complete Word Widget"]:::widget
        HistSearch["History Search Widget"]:::widget
        NavUp["Navigation Up"]:::widget
        NavDown["Navigation Down"]:::widget

        click CompleteWord "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Widgets/.autocomplete__complete-word__completion-widget"
        click HistSearch "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Widgets/.autocomplete__history-search__completion-widget"
        click NavUp "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Widgets/.autocomplete__up-line-or-search__zle-widget"
        click NavDown "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Widgets/.autocomplete__down-line-or-select__zle-widget"
    end

    subgraph Util["Utility Layer"]
        ZLEFlags["ZLE Flags"]:::util
        PatchUtil["Patch Utility"]:::util

        click ZLEFlags "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Util/.autocomplete__zle-flags"
        click PatchUtil "https://github.com/marlonrichert/zsh-autocomplete/blob/main/Functions/Util/.autocomplete__patch"
    end

    subgraph External["External Systems"]
        ZLE{{Zsh Line Editor}}:::external
        Shell{{Zsh Shell}}:::external
        FS[(File System)]:::storage
        Term([Terminal Interface]):::ui
    end

    Entry --> Config
    Entry --> KeyBind
    Entry --> CompInit
    Entry --> WidgetInit
    Entry --> RecentDirs
    Entry --> Async

    CompInit -.-> CmdComp
    CompInit -.-> RecentPaths
    CompInit -.-> Unambiguous
    CompInit -.-> HistLines

    WidgetInit --> CompleteWord
    WidgetInit --> HistSearch
    WidgetInit --> NavUp
    WidgetInit --> NavDown

    CompleteWord --> ZLE
    HistSearch --> ZLE
    NavUp --> ZLE
    NavDown --> ZLE

    ZLEFlags --> Widget
    PatchUtil --> Widget
    ZLEFlags --> Init
    PatchUtil --> Init

    RecentPaths --> FS
    RecentDirs --> FS

    ZLE --> Term
    Shell --> ZLE

    classDef core fill:#a4c2f4
    classDef init fill:#b6d7a8
    classDef comp fill:#f9cb9c
    classDef widget fill:#d5a6bd
    classDef util fill:#c27ba0
    classDef external fill:#f9cb9c
    classDef storage fill:#d5a6bd
    classDef ui fill:#b6d7a8
```
