# mokeyish/obsidian-code-emitter architecture

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

- Interactive diagram: https://gitdiagram.com/mokeyish/obsidian-code-emitter
- Repository: https://github.com/mokeyish/obsidian-code-emitter

## Overview

##### Project type and purpose
- This is an Obsidian plugin (“Obsidian Code Emitter”) that lets users execute code blocks interactively in their notes.
- It combines a UI layer (SolidJS-based front end), a plugin runtime layer (Obsidian API), local sandboxing (JavaScript/WebAssembly for JS/TS/Python), and network‐based language execution providers (e.g., Sololearn, play.rust-lang.org).

##### File structure
- Top‐level config:
- vite.config.ts, tsconfig.json, eslint.config.mjs → build/dev tooling
- manifest.json → Obsidian plugin metadata
- .github/workflows → CI pipelines
- src/
- main.tsx, hmr.ts, setting.ts, solidify.ts → plugin startup, HMR, settings registration
- backend/index.ts → orchestrator: routes code requests to either sandbox or external provider
- backend/languages/*.ts → per‐language configuration (endpoints, transpiling rules)
- backend/providers/*.ts → provider wrappers (Sololearn)
- lib/sandbox/*.ts → JS sandbox implementation (qiankun proxy), Pyodide integration, utility functions
- components/*.tsx/.scss/.css → UI controls: CodeBlock, Play button, Terminal output, Settings tab
- typings/ → ambient type definitions for Obsidian, Electron, etc.

##### README for additional insights
- Describes supported platforms, languages, execution modes (local sandbox vs. remote request), and security note.

##### Main components of the system (to show
A. Obsidian Host (plugin loader, UI container)
B. Frontend UI
- CodeBlock component (renders editable code, run button)
- Terminal component (displays output)
- SettingsTab (configures plugin options)
C. Plugin Core (backend/index.ts + store.ts)
- Orchestrator: receives run requests, reads language config, dispatches to sandbox or provider
D. Local Sandbox
- JS Sandbox (qiankun proxy) for JS/TS
- Pyodide for Python
E. Remote Providers
- Sololearn wrapper for C, C++, C#, Go, Java, R, Rust, Swift, etc.
- Direct REST calls (play.haskell.org, play.kotlinlang.org, play.rust-lang.org, vosca.dev, etc.)
F. Network Layer (fetch calls, HTTP)
G. Obsidian Data Store (optional: plugin settings persisted by Obsidian)

##### Relationships and interactions
1. User clicks “Run” on a CodeBlock → Frontend UI emits an event
2. Event goes to Plugin Core (store/orchestrator)
3. Orchestrator reads language metadata from backend/languages/index.ts
– If language ∈ {js, ts, python} → Local Sandbox path
– Else → Remote Provider path
4. Local Sandbox path
a. JS/TS sandbox: qiankun proxySandbox executes code in an isolated iframe/worker
b. Python sandbox: Pyodide WebAssembly runtime loads via lib/sandbox/common.ts
5. Remote Provider path
a. Build a POST request according to provider config (Sololearn or other endpoint)
b. Send code over HTTP, await compile/execute response
6. Plugin Core receives execution result (stdout, stderr, errors)
7. Sends result back to Frontend → Terminal component renders output

##### Architectural patterns and design principles
- Clear separation of concerns:
- UI (components) vs. orchestrator (backend/index.ts) vs. execution engines (sandbox/providers)
- Strategy pattern for language execution: each language module declares its “execute” strategy
- Adapter pattern for wrapping third‐party REST endpoints
- Modular: each language & provider in its own file for easy extension
- Secure isolation: local sandboxing via qiankun proxy to prevent host contamination

- [ ] All six main components (Obsidian Host, UI, Core, Sandbox, Providers, Network)
- [ ] Labels for critical paths (strategy selection, fetch calls, sandbox eval)
- [ ] Notation for TypeScript modules, WebAssembly runtime, and HTTP endpoints

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Obsidian Host Layer
    subgraph "Obsidian Host Layer"
        direction TB
        Manifest["manifest.json"] 
        MainTS["main.tsx"]
        HMR["hmr.ts"]
        Solidify["solidify.ts"]
        HostSetting["setting.ts"]
    end

    %% Plugin Frontend Layer
    subgraph "Plugin Frontend Layer"
        direction TB
        CodeBlock["CodeBlock.tsx"]:::ui
        PlayBtn["Play.tsx"]:::ui
        TermComp["Term.tsx"]:::ui
        SpinComp["Spin.tsx"]:::ui
        SettingTabUI["SettingTab.tsx"]:::ui
        IconComp["Icon.tsx"]:::ui
        UIStyle["style.css"]:::ui
    end

    %% Plugin Core Layer
    subgraph "Plugin Core Layer"
        direction TB
        CoreIndex["backend/index.ts"]:::core
        Store["backend/store.ts"]:::storage
        LangIndex["languages/index.ts"]:::core
    end

    %% Execution Layer: Local Sandbox
    subgraph "Local Sandbox Execution Engines"
        direction TB
        SandboxIndex["sandbox/index.ts"]:::exec
        ProxySandbox["proxySandbox.ts"]:::exec
        CommonSandbox["common.ts"]:::exec
        UtilsSandbox["utils.ts"]:::exec
        Interfaces["interfaces.ts"]:::exec
    end

    %% Execution Layer: Remote Providers
    subgraph "Remote Providers"
        direction TB
        SoloLearn["sololearn.ts"]:::exec
    end

    %% Network Layer
    subgraph "Network Layer"
        direction TB
        URLImport["url_import.ts"]:::core
        ExternalService[(Third-Party HTTP Endpoints)]:::external
    end

    %% Data Store
    subgraph "Obsidian Data Store"
        direction TB
        Store
        HostSetting
    end

    %% Connections
    CodeBlock -->|"runCode(lang, source)"| CoreIndex
    PlayBtn --> CoreIndex
    CoreIndex -->|"load strategy"| LangIndex
    LangIndex -->|"js/ts/python"| SandboxIndex
    SandboxIndex --> ProxySandbox
    SandboxIndex --> CommonSandbox
    CommonSandbox --> Interfaces
    CommonSandbox --> UtilsSandbox
    LangIndex -->|"others"| SoloLearn
    SoloLearn -->|"fetch POST"| ExternalService
    ExternalService -->|"response"| SoloLearn
    ProxySandbox -->|"result"| CoreIndex
    CommonSandbox -->|"result"| CoreIndex
    SoloLearn -->|"result"| CoreIndex
    CoreIndex -->|"stdout/stderr"| TermComp

    %% Click Events
    click Manifest "https://github.com/mokeyish/obsidian-code-emitter/blob/main/manifest.json"
    click MainTS "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/main.tsx"
    click HMR "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/hmr.ts"
    click Solidify "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/solidify.ts"
    click HostSetting "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/setting.ts"

    click CodeBlock "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/components/CodeBlock.tsx"
    click PlayBtn "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/components/Play.tsx"
    click TermComp "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/components/Term.tsx"
    click SpinComp "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/components/Spin.tsx"
    click SettingTabUI "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/components/SettingTab.tsx"
    click IconComp "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/components/Icon.tsx"
    click UIStyle "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/style.css"

    click CoreIndex "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/backend/index.ts"
    click Store "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/backend/store.ts"

    click LangIndex "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/backend/languages/index.ts"
    click ProxySandbox "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/lib/sandbox/proxySandbox.ts"
    click CommonSandbox "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/lib/sandbox/common.ts"
    click SandboxIndex "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/lib/sandbox/index.ts"
    click UtilsSandbox "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/lib/sandbox/utils.ts"
    click Interfaces "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/lib/sandbox/interfaces.ts"

    click SoloLearn "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/backend/providers/sololearn.ts"
    click URLImport "https://github.com/mokeyish/obsidian-code-emitter/blob/main/src/lib/url_import.ts"

    %% Styles
    classDef ui fill:#D0E8FF,stroke:#0366D6,color:#000
    classDef core fill:#E8F5D0,stroke:#2E8B57,color:#000
    classDef exec fill:#DFF0D8,stroke:#4CAF50,color:#000
    classDef storage fill:#FFF4D0,stroke:#DAA520,color:#000
    classDef external fill:#F0F0F0,stroke-dasharray: 5 5,stroke:#888,color:#000
```
