# sveltejs/svelte-devtools architecture

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

- Interactive diagram: https://gitdiagram.com/sveltejs/svelte-devtools
- Repository: https://github.com/sveltejs/svelte-devtools

## Overview

##### Project type and purpose
- This is a browser extension (“Svelte DevTools”) implemented as a PNPM workspace.
- Its purpose is to hook into a running Svelte-4 application in the browser, extract the component tree and state, and render an interactive UI panel inside the browser’s Developer Tools.

##### File structure
- Top-level: monorepo with `.github`, workspace settings, `package.json` and PNPM lockfiles.
- `workspace/extension`: the sole workspace package.
- `src/entry.ts`: DevTools panel entrypoint.
- `src/client/`: content‐script + injection utilities (core.js, runtime.js, highlight.js, svelte-4.js, utils.js).
- `src/lib/`: Svelte components (UI panel, toolbar, nodes, state management).
- `src/routes/`: top-level DevTools views (Profiler, Inspector, etc.).
- Configs: Rollup, Vite, TypeScript, Svelte.

##### README for additional insights
- Confirms this is a DevTools extension for Chrome/Firefox hooking into Svelte v4 apps compiled in dev mode.
- Describes development workflow: build (`pnpm dev`), load unpacked.

##### Main components & interactions
a. Browser environment
1. **Host Web Page**: any Svelte v4 application.
2. **Content Script** (`src/client/*.js`): injected into page context, loads `runtime.js` and `svelte-4.js`, listens for Svelte lifecycle and component events.
3. **Injected Runtime**: patches Svelte’s internal API at runtime to emit component tree changes.
b. Extension background & DevTools
4. **Background Script** (`static/background.js`): central message router using `chrome.runtime.onMessage`.
5. **DevTools Panel UI** (`src/entry.ts` + Svelte components in `src/lib` and `src/routes`): runs inside the DevTools sidebar, renders the tree, state inspector, profiler.
c. Build & deployment
6. **Builder** (Rollup/Vite via `rollup.config.js` + `vite.config.ts`): compiles TS, Svelte, bundles static assets into `build/`.
7. **Manifest** (`static/manifest.json`): declares content scripts, background, DevTools page, permissions.

##### Relationships & data flows
- Content Script ↔️ Host Page: injects code → receives Svelte state events
- Content Script → Background Script: forwards messages via `chrome.runtime.sendMessage`
- Background Script ↔️ DevTools Panel: relays messages between panel and content script
- DevTools Panel UI ← Svelte Components: displays tree & state; user edits → messages back through background → runtime → host page

##### Architectural patterns & design principles
- **Separation of concerns**:
- Page instrumentation (content scripts + runtime)
- Messaging/routing (background script)
- Presentation (DevTools Svelte UI)
- **Event-driven**: uses Chrome extension messaging API as pub/sub bus.
- **Modular client library**: `src/client` abstracts injection, highlighting, utilities.
- **Component-based UI**: Svelte components for nodes, panels, routes.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Web Page Context
    subgraph "Web Page" 
        direction TB
        Host["Svelte App (v4, dev mode)"]:::page
        CSRt["runtime.js"]:::page
        CSSv["svelte-4.js"]:::page
        CSCore["core.js"]:::page
        CSHighlight["highlight.js"]:::page
        CSUtil["utils.js"]:::page
    end

    %% Extension Background Context
    subgraph "Extension Background"
        direction TB
        BG["background.js"]:::bg
        Manifest["manifest.json"]:::bg
    end

    %% DevTools Panel Context
    subgraph "DevTools Panel"
        direction TB
        Entry["entry.ts"]:::ui
        App["App.svelte"]:::ui
        CSS["app.css"]:::ui

        subgraph "UI Components"
            direction TB
            Button["Button.svelte"]:::ui
            Divider["Divider.svelte"]:::ui
            Indexer["Indexer.svelte"]:::ui
            Relative["Relative.svelte"]:::ui
            Resizable["Resizable.svelte"]:::ui
            Toolbar["Toolbar.svelte"]:::ui
        end

        subgraph "Node Renderers"
            direction TB
            Block["Block.svelte"]:::ui
            Element["Element.svelte"]:::ui
            ElementAttr["ElementAttributes.svelte"]:::ui
            Ellipsis["Ellipsis.svelte"]:::ui
            Iteration["Iteration.svelte"]:::ui
            NodeNode["Node.svelte"]:::ui
            Slot["Slot.svelte"]:::ui
        end

        subgraph "Panel Subcomponents"
            direction TB
            Editable["Editable.svelte"]:::ui
            PropertyList["PropertyList.svelte"]:::ui
            CoreTS["core.svelte.ts"]:::ui
            RtsTS["runtime.svelte.ts"]:::ui
            StateTS["state.svelte.ts"]:::ui
        end

        subgraph "Routes"
            direction TB
            Breadcrumbs["Breadcrumbs.svelte"]:::ui
            ConnectMsg["ConnectMessage.svelte"]:::ui
            Inspector["Inspector.svelte"]:::ui
            ProfileBtn["ProfileButton.svelte"]:::ui
            Profiler["Profiler.svelte"]:::ui
            ProfilerFrame["ProfilerFrame.svelte"]:::ui
            SearchBox["SearchBox.svelte"]:::ui
            VisibilitySel["VisibilitySelection.svelte"]:::ui
        end
    end

    %% Build & Deployment
    subgraph "Build & Deployment"
        direction TB
        Rollup["rollup.config.js"]:::build
        Vite["vite.config.ts"]:::build
        SvelteCfg["svelte.config.js"]:::build
        TSConfig["tsconfig.json"]:::build
        PKGApp["package.json"]:::build
        RootPKG["root package.json"]:::build
    end

    %% Data Flows
    Host -->|"Svelte lifecycle events"| CSRt
    CSRt -->|"loads patch"| CSSv
    CSRt -->|"invokes core"| CSCore
    CSRt -->|"uses utils"| CSUtil
    CSCore -->|"highlight hooks"| CSHighlight

    %% Messaging through Background
    CSRt -->|"chrome.runtime.sendMessage"| BG
    BG -->|"chrome.runtime.onMessage"| Entry

    %% User interactions
    Entry -->|"renders UI"| App
    App -->|"uses components"| Button
    App -->|"uses components"| Divider
    App -->|"uses components"| Indexer
    App -->|"uses components"| Relative
    App -->|"uses components"| Resizable
    App -->|"uses components"| Toolbar
    App -->|"renders nodes"| Block
    App -->|"renders nodes"| Element
    App -->|"renders nodes"| ElementAttr
    App -->|"renders nodes"| Ellipsis
    App -->|"renders nodes"| Iteration
    App -->|"renders nodes"| NodeNode
    App -->|"renders nodes"| Slot
    App -->|"panels"| Editable
    App -->|"panels"| PropertyList
    App -->|"panels"| CoreTS
    App -->|"panels"| RtsTS
    App -->|"panels"| StateTS
    App -->|"routes"| Breadcrumbs
    App -->|"routes"| ConnectMsg
    App -->|"routes"| Inspector
    App -->|"routes"| ProfileBtn
    App -->|"routes"| Profiler
    App -->|"routes"| ProfilerFrame
    App -->|"routes"| SearchBox
    App -->|"routes"| VisibilitySel

    Entry -.->|"DevTools API"| BG
    BG -.->|"chrome.runtime.sendMessage"| CSRt
    CSRt -.->|"runtime patch calls"| Host

    %% Manifest and Build linkage
    Rollup --> Manifest
    Vite --> Manifest
    SvelteCfg --> Manifest
    TSConfig --> Manifest
    PKGApp --> Manifest
    RootPKG --> Manifest

    %% Click Events
    click CSRt "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/client/runtime.js"
    click CSSv "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/client/svelte-4.js"
    click CSCore "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/client/core.js"
    click CSHighlight "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/client/highlight.js"
    click CSUtil "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/client/utils.js"
    click BG "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/static/background.js"
    click Manifest "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/static/manifest.json"
    click Entry "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/entry.ts"
    click App "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/App.svelte"
    click CSS "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/app.css"
    click Button "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/components/Button.svelte"
    click Divider "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/components/Divider.svelte"
    click Indexer "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/components/Indexer.svelte"
    click Relative "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/components/Relative.svelte"
    click Resizable "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/components/Resizable.svelte"
    click Toolbar "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/components/Toolbar.svelte"
    click Block "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/nodes/Block.svelte"
    click Element "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/nodes/Element.svelte"
    click ElementAttr "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/nodes/ElementAttributes.svelte"
    click Ellipsis "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/nodes/Ellipsis.svelte"
    click Iteration "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/nodes/Iteration.svelte"
    click NodeNode "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/nodes/Node.svelte"
    click Slot "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/nodes/Slot.svelte"
    click Editable "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/panel/Editable.svelte"
    click PropertyList "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/panel/PropertyList.svelte"
    click CoreTS "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/panel/core.svelte.ts"
    click RtsTS "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/panel/runtime.svelte.ts"
    click StateTS "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/lib/panel/state.svelte.ts"
    click Breadcrumbs "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/routes/Breadcrumbs.svelte"
    click ConnectMsg "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/routes/ConnectMessage.svelte"
    click Inspector "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/routes/Inspector.svelte"
    click ProfileBtn "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/routes/ProfileButton.svelte"
    click Profiler "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/routes/Profiler.svelte"
    click ProfilerFrame "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/routes/ProfilerFrame.svelte"
    click SearchBox "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/routes/SearchBox.svelte"
    click VisibilitySel "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/src/routes/VisibilitySelection.svelte"
    click Rollup "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/rollup.config.js"
    click Vite "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/vite.config.ts"
    click SvelteCfg "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/svelte.config.js"
    click TSConfig "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/tsconfig.json"
    click PKGApp "https://github.com/sveltejs/svelte-devtools/blob/master/workspace/extension/package.json"
    click RootPKG "https://github.com/sveltejs/svelte-devtools/blob/master/root package.json"

    %% Styles
    classDef page fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef bg fill:#98FB98,stroke:#333,stroke-width:1px
    classDef ui fill:#FFD580,stroke:#333,stroke-width:1px
    classDef build fill:#E8E8E8,stroke:#333,stroke-width:1px
```
