# microsoft/edit architecture

> Architecture diagram of the GitHub repository microsoft/edit, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-09-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/microsoft/edit
- Repository: https://github.com/microsoft/edit

## Overview

Edit is a terminal text editor aimed at accessible, interactive editing. The principal workflow starts with opening a file or creating an untitled document, then accepts keyboard and mouse interaction, edits a Unicode-aware buffer, and redraws the terminal UI; users can save changes back to files. The repository also includes syntax highlighting via the `lsh` crate, search and replace, clipboard support, file picking, and settings/localization. The README documents optional ICU support for search and replace. The excerpts show the main loop and buffer behavior, but not every subsystem’s wiring.

Main entry points: [`crates/edit/src/bin/edit/main.rs`](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/main.rs) (Application loop), [`crates/edit/src/buffer/mod.rs`](https://github.com/microsoft/edit/blob/main/crates/edit/src/buffer/mod.rs) (Text buffer), [`crates/edit/src/bin/edit/documents.rs`](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/documents.rs) (Document manager), [`crates/edit/src/tui.rs`](https://github.com/microsoft/edit/blob/main/crates/edit/src/tui.rs) (Immediate-mode UI)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["Editor application"]
  node_main["Application loop<br/>[main.rs]"]
  node_state["Editor state<br/>[state.rs]"]
  node_settings["Settings<br/>[settings.rs]"]
  node_localization["Localization<br/>[localization.rs]"]
end

subgraph group_editing["Editing and documents"]
  node_documents["Document manager<br/>[documents.rs]"]
  node_document["Document model<br/>[document.rs]"]
  node_buffer["Text buffer<br/>[mod.rs]"]
  node_gap_buffer["Gap buffer<br/>[gap_buffer.rs]"]
  node_unicode["Unicode handling<br/>[mod.rs]"]
  node_clipboard["Clipboard<br/>[clipboard.rs]"]
  node_search["Search and replace<br/>[mod.rs]"]
end

subgraph group_interface["Terminal interface"]
  node_tui["Immediate-mode UI<br/>[tui.rs]"]
  node_editor_view["Editor rendering<br/>[draw_editor.rs]"]
  node_file_picker["File picker<br/>[draw_filepicker.rs]"]
  node_menubar["Menu bar<br/>[draw_menubar.rs]"]
  node_statusbar["Status bar<br/>[draw_statusbar.rs]"]
  node_sys["Platform terminal I/O<br/>[mod.rs]"]
end

subgraph group_language["Language services"]
  node_highlighter["Syntax highlighter<br/>[runtime.rs]"]
  node_definitions["Highlight definitions<br/>[lib.rs]"]
end

node_user(("Editor user"))
node_terminal["Terminal"]
node_filesystem["File system"]
node_host_clipboard["Host clipboard"]
node_icu["ICU library"]

node_user -->|"operates"| node_main
node_main -->|"opens documents"| node_documents
node_documents -->|"manages"| node_document
node_documents -->|"reads and writes"| node_filesystem
node_document -->|"holds text"| node_buffer
node_buffer -->|"stores edits"| node_gap_buffer
node_buffer -->|"uses character rules"| node_unicode
node_main -->|"updates state"| node_state
node_main -->|"renders interface"| node_tui
node_main -->|"sets up terminal"| node_sys
node_sys -->|"reads and writes"| node_terminal
node_main -->|"draws editor"| node_editor_view
node_main -->|"draws picker"| node_file_picker
node_main -->|"draws menus"| node_menubar
node_main -->|"draws status"| node_statusbar
node_editor_view -->|"displays text"| node_buffer
node_tui -->|"dispatches editing"| node_buffer
node_tui -->|"handles clipboard"| node_clipboard
node_main -->|"syncs clipboard"| node_host_clipboard
node_main -->|"uses settings"| node_settings
node_main -->|"uses translations"| node_localization
node_editor_view -->|"highlights text"| node_highlighter
node_highlighter -->|"uses definitions"| node_definitions
node_buffer -->|"searches and replaces"| node_search
node_search -.->|"optionally uses"| node_icu

click node_main "https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/main.rs"
click node_state "https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/state.rs"
click node_settings "https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/settings.rs"
click node_localization "https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/localization.rs"
click node_documents "https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/documents.rs"
click node_document "https://github.com/microsoft/edit/blob/main/crates/edit/src/document.rs"
click node_buffer "https://github.com/microsoft/edit/blob/main/crates/edit/src/buffer/mod.rs"
click node_gap_buffer "https://github.com/microsoft/edit/blob/main/crates/edit/src/buffer/gap_buffer.rs"
click node_unicode "https://github.com/microsoft/edit/blob/main/crates/edit/src/unicode/mod.rs"
click node_clipboard "https://github.com/microsoft/edit/blob/main/crates/edit/src/clipboard.rs"
click node_tui "https://github.com/microsoft/edit/blob/main/crates/edit/src/tui.rs"
click node_editor_view "https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/draw_editor.rs"
click node_file_picker "https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/draw_filepicker.rs"
click node_menubar "https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/draw_menubar.rs"
click node_statusbar "https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/draw_statusbar.rs"
click node_sys "https://github.com/microsoft/edit/blob/main/crates/edit/src/sys/mod.rs"
click node_highlighter "https://github.com/microsoft/edit/blob/main/crates/lsh/src/runtime.rs"
click node_definitions "https://github.com/microsoft/edit/blob/main/crates/lsh/src/lib.rs"
click node_search "https://github.com/microsoft/edit/blob/main/crates/edit/src/buffer/mod.rs"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main,node_state,node_settings,node_localization,node_user toneBlue
class node_documents,node_document,node_buffer,node_gap_buffer,node_unicode,node_clipboard,node_search toneAmber
class node_tui,node_editor_view,node_file_picker,node_menubar,node_statusbar,node_sys toneMint
class node_highlighter,node_definitions toneRose
class node_terminal,node_filesystem,node_host_clipboard,node_icu toneIndigo
```

## Components

### Editor application

- [Application loop](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/main.rs): `crates/edit/src/bin/edit/main.rs`
- [Editor state](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/state.rs): `crates/edit/src/bin/edit/state.rs`
- [Settings](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/settings.rs): `crates/edit/src/bin/edit/settings.rs`
- [Localization](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/localization.rs): `crates/edit/src/bin/edit/localization.rs`

### Editing and documents

- [Document manager](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/documents.rs): `crates/edit/src/bin/edit/documents.rs`
- [Document model](https://github.com/microsoft/edit/blob/main/crates/edit/src/document.rs): `crates/edit/src/document.rs`
- [Text buffer](https://github.com/microsoft/edit/blob/main/crates/edit/src/buffer/mod.rs): `crates/edit/src/buffer/mod.rs`
- [Gap buffer](https://github.com/microsoft/edit/blob/main/crates/edit/src/buffer/gap_buffer.rs): `crates/edit/src/buffer/gap_buffer.rs`
- [Unicode handling](https://github.com/microsoft/edit/blob/main/crates/edit/src/unicode/mod.rs): `crates/edit/src/unicode/mod.rs`
- [Clipboard](https://github.com/microsoft/edit/blob/main/crates/edit/src/clipboard.rs): `crates/edit/src/clipboard.rs`
- [Search and replace](https://github.com/microsoft/edit/blob/main/crates/edit/src/buffer/mod.rs): `crates/edit/src/buffer/mod.rs`

### Terminal interface

- [Immediate-mode UI](https://github.com/microsoft/edit/blob/main/crates/edit/src/tui.rs): `crates/edit/src/tui.rs`
- [Editor rendering](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/draw_editor.rs): `crates/edit/src/bin/edit/draw_editor.rs`
- [File picker](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/draw_filepicker.rs): `crates/edit/src/bin/edit/draw_filepicker.rs`
- [Menu bar](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/draw_menubar.rs): `crates/edit/src/bin/edit/draw_menubar.rs`
- [Status bar](https://github.com/microsoft/edit/blob/main/crates/edit/src/bin/edit/draw_statusbar.rs): `crates/edit/src/bin/edit/draw_statusbar.rs`
- [Platform terminal I/O](https://github.com/microsoft/edit/blob/main/crates/edit/src/sys/mod.rs): `crates/edit/src/sys/mod.rs`

### Language services

- [Syntax highlighter](https://github.com/microsoft/edit/blob/main/crates/lsh/src/runtime.rs): `crates/lsh/src/runtime.rs`
- [Highlight definitions](https://github.com/microsoft/edit/blob/main/crates/lsh/src/lib.rs): `crates/lsh/src/lib.rs`

### Other components

- **Editor user**
- **Terminal**
- **File system**
- **Host clipboard**
- **ICU library**

## Connections

- Editor user → Application loop: operates
- Application loop → Document manager: opens documents
- Document manager → Document model: manages
- Document manager → File system: reads and writes
- Document model → Text buffer: holds text
- Text buffer → Gap buffer: stores edits
- Text buffer → Unicode handling: uses character rules
- Application loop → Editor state: updates state
- Application loop → Immediate-mode UI: renders interface
- Application loop → Platform terminal I/O: sets up terminal
- Platform terminal I/O → Terminal: reads and writes
- Application loop → Editor rendering: draws editor
- Application loop → File picker: draws picker
- Application loop → Menu bar: draws menus
- Application loop → Status bar: draws status
- Editor rendering → Text buffer: displays text
- Immediate-mode UI → Text buffer: dispatches editing
- Immediate-mode UI → Clipboard: handles clipboard
- Application loop → Host clipboard: syncs clipboard
- Application loop → Settings: uses settings
- Application loop → Localization: uses translations
- Editor rendering → Syntax highlighter: highlights text
- Syntax highlighter → Highlight definitions: uses definitions
- Text buffer → Search and replace: searches and replaces
- Search and replace → ICU library: optionally uses
