Elgato_dark/Neon-Vision-Editor
1
0
Fork 0
mirror of https://github.com/h3pdesign/Neon-Vision-Editor synced 2026-04-21 13:27:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

ARCHITECTURE.md erstellen

Browse source
This commit is contained in:
h3p 2026-02-15 07:29:17 +01:00 committed by GitHub
parent e4e07a5e66
commit 0422828d72
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 22 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
ARCHITECTURE.md Normal file
View file

@ -0,0 +1,22 @@
# Neon Vision Architecture Guide
## High-Level Overview
Neon Vision is a **native SwiftUI application** targeting macOS 14.0+ (Sonoma/Tahoe). Unlike Electron editors, we rely on Apple's **TextKit 2** and **SwiftUI** for rendering to ensure zero-latency typing.
## Core Modules
### 1. The Editor Engine (`/Core/Editor`)
* **Backing Store**: We do not load entire files into memory strings. We use a `Rope` data structure (or `mmap` for large files >10MB) to handle inserts/deletes efficiently.
* **Syntax Highlighting**: Powered by `TreeSitter`.
* *Performance Note*: Highlighting runs on a background `DispatchQueue`. The main thread only receives the final `NSAttributedString` for the visible viewport.
### 2. File System & Sandboxing (`/Core/FileSystem`)
* **Security Scoped Bookmarks**: To support the "Open Recent" menu in a sandboxed environment (required for App Store), we persist security-scoped bookmarks, not just file paths.
* **Coordinator**: All file writes go through `NSFileCoordinator` to prevent data races with external edits.
### 3. Window Management
* **Multi-Window**: Neon uses `WindowGroup` with `id` injection to support multiple independent editor instances. State is not shared between windows unless explicitly passed via `AppDependencyContainer`.
## Key Challenges for Contributors
* **Large Files**: Editing files >100MB is currently experimental. Logic for "chunking" lines lives in `LineManager.swift`.
* **Vim Mode**: State machine located in `VimInputController.swift`. All key events are intercepted before they reach the standard `NSTextInputClient`.