# dgdiniz/bass_vscode architecture

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

- Interactive diagram: https://gitdiagram.com/dgdiniz/bass_vscode
- Repository: https://github.com/dgdiniz/bass_vscode

## Overview

##### Component Details

Client-side (VSCode Extension):
- Text Editor Interface
- Decoration Manager (from errorDecorations.js and keywordDecorations.js)
- Event Handler System (from eventListeners.js)
- State Management (from state.js)

Server-side:
- Completion Provider (from completion.js)
- Language Server Core (from server.js)

Syntax Definition:
- SNES Grammar
- MegaDrive Grammar
- NES Grammar

##### Connection and Data Flow
- Grammar files feeding into the syntax highlighting system
- Completion provider feeding suggestions to the editor
- Decoration manager applying styles to the editor

##### External Integration
- A component for the Bass Assembler (external dependency)
- Connection between Language Server and Bass Assembler

##### The dependency on the custom Bass assembler version

Key Relationships to Highlight:
- How the client communicates with the language server using the LSP protocol
- How different file extensions trigger different syntax highlighting rules
- How the decoration system integrates with the editor
- How code completion suggestions are generated and delivered

Level of Detail:
- Keep the main components visible at a glance
- Use subcomponents to show implementation details
- Notes about required external dependencies (Bass assembler ≥18.1.2)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef client fill:#a8d1f0,stroke:#333
    classDef server fill:#90EE90,stroke:#333
    classDef syntax fill:#FFB347,stroke:#333
    classDef external fill:#D3D3D3,stroke:#333
    classDef interface fill:#fff,stroke:#333

    %% Main Sections
    subgraph VSCode["VSCode Editor Environment"]
        Client["VSCode Extension Client"]:::client
        Editor["Text Editor Interface"]:::interface
        DecManager["Decoration Manager"]:::client
        EventSystem["Event Handler System"]:::client
        StateManager["State Management"]:::client
    end

    subgraph Server["Language Server"]
        LSCore["Language Server Core"]:::server
        CompProvider["Completion Provider"]:::server
    end

    subgraph SyntaxDefs["Syntax Definitions"]
        SNES["SNES Grammar"]:::syntax
        MegaDrive["MegaDrive Grammar"]:::syntax
        NES["NES Grammar"]:::syntax
    end

    subgraph External["External Dependencies"]
        BassAsm["Bass Assembler ≥18.1.2"]:::external
    end

    %% Connections
    Client <--> LSCore
    LSCore <--> CompProvider
    CompProvider --> Editor
    
    DecManager --> Editor
    EventSystem --> Editor
    StateManager --> Client
    
    SNES --> Client
    MegaDrive --> Client
    NES --> Client
    
    LSCore --> BassAsm

    %% Click Events
    click Client "https://github.com/Dgdiniz/bass_vscode/blob/main/client/client.js"
    click DecManager "https://github.com/Dgdiniz/bass_vscode/blob/main/client/errorDecorations.js"
    click EventSystem "https://github.com/Dgdiniz/bass_vscode/blob/main/client/eventListeners.js"
    click StateManager "https://github.com/Dgdiniz/bass_vscode/blob/main/client/state.js"
    click LSCore "https://github.com/Dgdiniz/bass_vscode/blob/main/server/server.js"
    click CompProvider "https://github.com/Dgdiniz/bass_vscode/blob/main/server/completion.js"
    click SNES "https://github.com/Dgdiniz/bass_vscode/blob/main/syntaxes/snes.asm.tmLanguage.json"
    click MegaDrive "https://github.com/Dgdiniz/bass_vscode/blob/main/syntaxes/megadrive.asm.tmLanguage.json"
    click NES "https://github.com/Dgdiniz/bass_vscode/blob/main/syntaxes/nes.asm.tmLanguage.json"

    %% Legend
    subgraph Legend
        Client1["Client Components"]:::client
        Server1["Server Components"]:::server
        Syntax1["Syntax Components"]:::syntax
        External1["External Dependencies"]:::external
        Interface1["Interface Elements"]:::interface
    end

    %% Notes
    note["File Extensions:
    .snes.asm → SNES
    .genesis.asm/.megadrive.asm → Mega Drive
    .nes.asm → NES"]
```
