# pierrad/obsidian-github-copilot architecture

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

- Interactive diagram: https://gitdiagram.com/pierrad/obsidian-github-copilot
- Repository: https://github.com/pierrad/obsidian-github-copilot

## Overview

- User Input → Obsidian Editor → Extension System
- Extension System → Copilot Integration Layer → Github Copilot Service
- Github Copilot Service → Copilot Integration Layer → Extension System
- Extension System → Obsidian Editor (displaying suggestions)

- Event System ⟷ All Components
- Settings Manager → All Components
- Authentication Flow → Github Copilot Service

##### Important Elements to Highlight

a. Authentication Flow:
- Node.js requirement (v18+)
- Github Copilot authentication process
- Token management

b. Feature Controls:
- Suggestion generation delay
- Keybinding configuration
- Automatic vs. manual triggers
- Code block vs. whole note suggestions
- Folder/file exclusions

- Node.js runtime
- TypeScript/JavaScript
- Obsidian Plugin API
- React Components (for UI elements)

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Core
        Main["Main Plugin Entry"]:::core
        Settings["Settings Manager"]:::core
        Status["Status Bar"]:::core
        Auth["Authentication Modal"]:::core
    end

    subgraph CopilotLayer
        Agent["Copilot Agent"]:::copilot
        Client["Copilot Client"]:::copilot
        Cache["Caching System"]:::copilot
    end

    subgraph ExtensionSystem
        ExtMgr["Extension Manager"]:::extension
        InlinePlug["Inline Suggestion Plugin"]:::extension
        InlineState["Inline Suggestion State"]:::extension
        KeyWatch["Keybinding Watcher"]:::extension
    end

    subgraph EventSystem
        EventMgr["Event Manager"]:::event
        EventLis["Event Listener"]:::event
    end

    subgraph External
        GithubCopilot["Github Copilot Service"]:::external
        ObsidianAPI["Obsidian Editor API"]:::external
    end

    %% Core Connections
    Main --> Settings
    Main --> Status
    Main --> Auth
    Main --> ExtMgr

    %% Copilot Layer Connections
    Agent --> Client
    Client --> Cache
    Client --> GithubCopilot
    Auth -.-> GithubCopilot

    %% Extension System Connections
    ExtMgr --> InlinePlug
    InlinePlug --> InlineState
    InlinePlug --> KeyWatch
    InlinePlug --> ObsidianAPI

    %% Event System Connections
    EventMgr -.-> Main
    EventMgr -.-> Agent
    EventMgr -.-> ExtMgr
    EventLis -.-> EventMgr

    %% Data Flow
    ObsidianAPI --> InlinePlug
    InlinePlug --> Agent
    Agent --> InlinePlug

    %% Click Events
    click Main "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/main.ts"
    click Settings "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/settings/CopilotPluginSettingTab.tsx"
    click Status "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/status/StatusBar.ts"
    click Auth "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/modal/AuthModal.ts"
    click Agent "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/copilot/CopilotAgent.ts"
    click Client "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/copilot/Client.ts"
    click Cache "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/copilot/Cacher.ts"
    click ExtMgr "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/extensions/ExtensionManager.ts"
    click InlinePlug "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/extensions/InlineSuggestionPlugin.ts"
    click InlineState "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/extensions/InlineSuggestionState.ts"
    click KeyWatch "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/extensions/InlineSuggestionKeyWatcher.ts"
    click EventMgr "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/events/EventManager.ts"
    click EventLis "https://github.com/Pierrad/obsidian-github-copilot/blob/master/src/events/EventListener.ts"

    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef copilot fill:#2ecc71,stroke:#27ae60,color:white
    classDef extension fill:#e67e22,stroke:#d35400,color:white
    classDef event fill:#9b59b6,stroke:#8e44ad,color:white
    classDef external fill:#95a5a6,stroke:#7f8c8d,color:white

    %% Legend
    subgraph Legend
        CoreLegend["Core Components"]:::core
        CopilotLegend["Copilot Integration"]:::copilot
        ExtensionLegend["Extension System"]:::extension
        EventLegend["Event System"]:::event
        ExternalLegend["External Systems"]:::external
    end
```
