Skip to content

ROADMAP.md

Latest commit

 

History

History
420 lines (314 loc) · 43.3 KB

ROADMAP.md

File metadata and controls

420 lines (314 loc) · 43.3 KB
Raw

Ferrite Roadmap

Forward-looking plan for Ferrite — what we're building next. Shipped releases: CHANGELOG.md (latest stable: v0.3.0, May 22, 2026).

In Progress — v0.3.1

Theme: Mermaid wave 2, rich embeds, multi-window, data/table UX, GitHub HTML subset, and polish — not LSP (deferred to v0.3.2).

PRD: docs/ai-workflow/prds/prd-v0.3.1.md · Changelog (WIP): CHANGELOG.md § Unreleased

Landed on master (not yet tagged)

Still targeting v0.3.1

Area Highlights
Mermaid Git graph rewrite, mmdr evaluation spike, manual layout, FC-83b / linkStyle polish
Embeds wry WebView or thumbnail fallback (parsing done) (#119)
Multi-window Second viewport / tab strip (#125)
Tables & CSV GFM column alignment (#140); CSV Tab nav + row/column ops; raw-mode column guides
Rendered polish Click-to-edit cursor precision; code-block Run hardening
GitHub HTML Phases 1–2 (<details>, <kbd>, <sup>/<sub>, sized images)
Editor UX Preview lock (#144); Alt+Z word wrap (#145)
Platform gates Verify and close #106, #111, #112 on real hardware
Workspace UI File tree hover + active-file emphasis (#135)

Explicitly deferred: LSP integration (all phases) → v0.3.2 (remains behind the lsp Cargo feature flag).

Detail checklist: v0.3.1 planned features below.

Known Issues

FerriteEditor Limitations

With the v0.2.6 custom editor, most previous egui TextEdit limitations are resolved. Remaining issues:

  • IME candidate box positioning (#15, #103) - Fixed in v0.2.8. Applied layer_transform_to_global() to IME coordinates.
  • IME backspace deleting text (#91) - Fixed in v0.2.7. Backspace during IME composition no longer deletes editor text.
  • Wrapped line scroll stuttering - Scrolling through documents with many word-wrapped lines still shows micro-stuttering. Likely related to per-line galley layout cost or height cache granularity. Needs further investigation.

Deferred

  • Bidirectional scroll sync — Shipped in v0.3.0. Split-view live sync with line+fraction anchors, idle snap (~120ms), top/bottom boundaries, minimap footer Sync / 2-way, and mode-toggle (Ctrl+E) hybrid sync. See docs/technical/sync-scrolling.md.
  • New file templates - Optional frontmatter templates when creating new markdown files. Deferred from v0.2.7.

Platform & Distribution

  • macOS Gatekeeper blocking (#93) - Fixed: CI now packages proper .app bundle via cargo-bundle.
  • macOS 15.x Gatekeeper on unsigned GitHub releases (#130) - GitHub CI .app artifacts are unsigned (Apple Developer Program not planned). Users may need quarantine removal or Open Anyway. Documented: docs/install/macos.md. Workaround docs remain the long-term approach.
  • Wayland keyboard input on Ubuntu 24.04 (#106) - v0.3.0 ships egui 0.34 / winit 0.31+. Release gate: confirm on real Ubuntu 24.04 Wayland before closing #106; until then the workaround remains WAYLAND_DISPLAY= ferrite for 0.2.x builds.
  • macOS Sonoma keyboard input (#111) - v0.3.0 ships the 0.34 stack; release gate: verify on Sonoma hardware before closing #111.
  • Windows 11 borderless window offset (#112) - Fixed in v0.2.8 with .with_transparent(true) DWM workaround. v0.3.0 ships egui 0.34.2 / winit 0.31+ stack (Task 38); close #112 after verification on target hardware.

Terminal

  • CJK double-width character overlap in terminal (#110) - Fixed in v0.2.8. Added unicode-width crate, 2-column cursor advancement, wide char rendering spanning 2 cells.

Rendered View Limitations

  • Slow rendering on large documents (#105) - Fixed in v0.2.8. AST caching, viewport culling, block height cache, and lazy estimation bring large-file rendered view to usable performance.
  • Mermaid flowchart edges cross node boxes (#83, FC-83a) — Landed for v0.3.0. Obstacle-aware forward routing, orthogonal back-edge side channels at BACK_EDGE_LOOP_MARGIN = 24 px, painter sizing from actual node/subgraph bounds (no clipped loops), asymmetric back-edge padding (loop clearance only on the side that needs it), TD/BT layer centering on max_cross_size (fixes large left gap / right-shifted diagrams in wide containers), parallel back-edge lanes (E → B and F → B no longer merge), inner E → B exits top-outer corner and rises vertically along the source edge before entering Preview at side-centre, and {decide} snaps under Preview via alone-on-layer barycenter shift. Same-layer sibling overlap (coffee-machine C/H, D/G) fixed via resolve_layer_overlaps safety net. Docs: flowchart-edge-obstacle-routing.md, flowchart-layout-algorithm.md. FC-83b (fa:… Font Awesome labels) and linkStyle interpolate basis curves remain open — see parity matrix.
  • Double-click / stuck edit in rendered WYSIWYG — Shipped in v0.3.0 (Tasks 94–105). Consolidated RenderedEditSession coordinator: one-click block switching, stable source_epoch widget ids, formatted click-to-edit lifecycle, tables on session model, split-view parity, block-commit undo. Manual acceptance: RS-1…RS-7 in v0.3.0-regression-matrix.md §3.12. Hub: rendered-edit-session.md.
  • Task list checkbox scroll jump — Toggling - [ ] / - [x] in rendered/split view no longer shifts scroll position when the user has not scrolled. Viewport culling reuses layout when block line ranges are unchanged; checkbox clicks no longer trigger scroll cooldown. See task-list-checkbox.md, CHANGELOG.md § 0.3.0 Fixed.
  • Click-to-edit cursor drift on mixed-format lines — v0.3.0 session + galley mapping (Task 100 follow-up) improved most cases; residual 1–2 character offset may remain on wrapped lines, links, and heavy inline nesting. Fix: v0.3.1 — see Rendered click-to-edit cursor precision.

Executable Code Blocks (v0.3.0)

Core Run (shell + Python, inline output, timeout, Stop) works for typical use; manual checklist: test_md/test_code_execution.md. Remaining edge cases (Windows bash without Git Bash, sh/zsh fallback, run state keyed by line number, copy/insert stderr format) are documented in code-block-run.md § Known limitations. Fixes: v0.3.1 — see Planned Features → v0.3.1 → Executable code blocks — hardening.

Planned Features

v0.3.1 — Mermaid, Embeds, Multi-Window, Data & Polish

Theme: Mermaid wave 2, video embed playback, GitHub HTML parity (Phases 1–2), multi-window document comparison, data-viewer / table UX, and editor polish. LSP is deferred to v0.3.2 (see below).

GitHub issues tagged 0.3.1: #119 (embeds), #125 (multi-window), #140 (table alignment), #135 (file tree polish), #144 (preview lock), #145 (Alt+Z word wrap), #115 (native decorations — optional).

Platform verification (v0.3.0 release gates)

  • Close or update #106 (Ubuntu 24.04 Wayland keyboard) once verified on real hardware with egui 0.34.
  • Close or update #111 (macOS Sonoma keyboard) once verified on Sonoma hardware.
  • Close or update #112 (Windows borderless offset) once verified on target hardware.
  • Re-run v0.3.0-regression-matrix.md on any platform where input/window behavior changed.

Platform — Single-instance foreground (landed)

Embedded Media — YouTube / Video Embeds (#119)

  • Custom syntax detection — {{video URL}} and bare YouTube paragraphs in markdown/parser.rs + video_embed.rs. See video-embed-parsing.md.
  • Embedded web view via wry - Use Tauri's wry crate to spawn a platform-native WebView (WebView2 on Windows, WebKitGTK on Linux, WebKit on macOS) as a child window positioned over the egui rendered view.
  • Viewport tracking - Sync the child WebView position/size with the egui rect each frame; hide when scrolled off-screen or tab is inactive.
  • Fallback: thumbnail + open-in-browser - For platforms where wry child windows aren't viable, fetch YouTube thumbnail (img.youtube.com) and render as clickable image with play overlay; click opens system browser.
  • Extensible embed system - Design the embed trait/interface to support future providers (Vimeo, etc.).

Note: This is an exploratory feature. The wry child-window-over-egui approach has known challenges (z-ordering, scroll sync, platform quirks). The thumbnail fallback ensures the feature ships something usable regardless.

HTML Rendering — GitHub Parity (Phase 1 & 2)

Phase 1 – Block Elements

  • <div align="...">, <details><summary>, <br>

Phase 2 – Inline Elements

  • <kbd>, <sup>, <sub>, <img width/height>

Note: Safe subset only (no scripts, styles, iframes). Phase 3 (nested HTML, HTML tables) is in v0.3.2.

Mermaid Improvements — Second Wave (Heavy)

  • Git Graph rewrite - Horizontal timeline, branch lanes, and merge visualization (#83 parity; see mermaid-parity-matrix.md).
  • Evaluate mermaid-rs-renderer (mmdr) parser integration - The mmdr crate supports 23 diagram types in pure Rust. Evaluate parser reuse while keeping native egui rendering (mmdr outputs SVG). Deliverable: decision doc + spike; unlocks v0.3.2 diagram types if adopted.
  • Manual layout support
    • Comment-based position hints: %% @pos <node_id> <x> <y>
    • Drag-to-reposition in rendered view with source auto-update
    • Export option to strip layout hints ("Export clean")

Mermaid Improvements — Flowchart polish (post–FC-83a)

Parser already accepts these; rendering gaps remain on common repros.

  • Font Awesome / fa: icon prefixes in node labels (FC-83b) — Strip gracefully or render placeholder; repro: test_md/test_mermaid_issue_83.md.
  • linkStyle interpolate basis — Document as unsupported or map to existing curved routing default.

Memory & Runtime — Loaded Modules Panel

Context: CJK and complex-script fonts load lazily at first use but stay session-pinned (no unload today — same one-way atomic flags as v0.2.6 CJK lazy loading; LSP idle shutdown is the only existing “unload” pattern). Opening multi-script test files can add ~80 MB that persists after tab close. This panel makes that visible and optionally reversible.

Phase 1 — Stats tab visibility (read-only)

  • Runtime section in Stats panel — New block at the bottom of the right-side Stats tab (app-global, not per-document): which CJK families (KR/JP/SC/TC) and complex-script families (Arabic, Bengali, Devanagari, Thai, Hebrew, Tamil, Georgian, Armenian, Ethiopic, Other Indic, Southeast Asian) are loaded; Mermaid diagram cache size; LSP server status; terminal panel visibility / session count.
  • RuntimeModulesInfo snapshot — Aggregate from fonts::get_loaded_cjk_fonts(), new get_loaded_complex_script_fonts(), mermaid::get_cache_stats(), LSP status map, terminal manager.

Phase 2 — Manual unload controls (opt-in)

  • Per-family font unload — unload_cjk_script / unload_complex_script in fonts.rs: clear atomic flag, rebuild FontDefinitions, bump_font_generation(), invalidate shaped/line caches. Disable button when an open tab or UI language still needs that script; confirm dialog before unload (tofu until reload).
  • Service actions — Clear Mermaid cache (clear_diagram_cache()), stop LSP server, close terminal panel / kill PTY sessions.
  • Docs — Note that OS working set may not drop immediately (mimalloc); unload is best-effort for session RAM hygiene.

Data Viewers — CSV Rendered Editing

MVP (landed on master)

  • Cell value editing in Rendered view — Double-click → inline edit; Enter commits, Escape cancels; undo integration.
  • CSV serialization — csv::Writer (RFC 4180 quoting, delimiter + header settings).
  • Small files only (<1 MB full-parse path) — Edit against cached CsvData; large lazy-parsed files show “edit in Raw view”. See csv-viewer.md.

Follow-ups (same release if time, else v0.3.2)

  • Tab / Shift+Tab between cells — Reuse deferred-commit + lock_focus patterns from EditableTable / table-cell-focus-navigation.md.
  • Add/remove rows & columns — Toolbar controls; structural changes commit immediately.
  • Large-file rendered editing — Row-level patch or load-on-first-edit; architectural follow-up.

Docs: extend docs/technical/viewers/csv-viewer.md when implemented.

Rendered View — Click-to-Edit Cursor Precision

Context: v0.3.0 shipped RenderedEditSession + single-galley display for formatted blocks (Task 100). Follow-up work in-tree improved bold/code/link mapping and wrap-width parity; placement is good enough for release but not pixel-perfect — e.g. ~1–2 character drift on wrapped lines or markdown links on long list items. Hub: rendered-edit-session-formatted.md, galley-cursor-positioning.md.

  • Unified layout source of truth — Build display + hit-test LayoutJob from the same AST walk as render_inline_node (or shared helper), not a parallel raw-string parser; eliminates drift when parser and comrak disagree (links, wikilinks, nested emphasis).
  • Wrap-width & multi-line parity — Persist per-block layout_wrap_width (and line height) on the session or egui temp store so click mapping never re-layouts with a different width than paint; add regression tests for wrapped list items and long paragraphs (RS-2 extension).
  • Link & wikilink edge cases — Reference-style links, autolinks, nested () in URLs, [[target|display]]; optional thin link hit-target overlays if galley-only display must stay (trade-off: click link vs enter edit).
  • Delimiter coverage — _italic_, __bold__, strikethrough/ code combinations in parse_inline_markdown or superseded AST path; match map_displayed_to_raw exactly.
  • Manual acceptance matrix — Extend v0.3.0-regression-matrix.md §3.12 / RS-2 with link-heavy and wrapped-line click targets; document known limits if any remain.

Editor — Raw Mode Table Column Alignment (display-only)

Context: GFM pipe tables in Raw view are hard to scan when |, **, ~~, and links shift columns. Rendered mode already has EditableTable with galley-based column widths on stripped cell text (TableData, layout_no_wrap in widgets.rs). This feature improves Raw readability without mutating the file — padding is visual only (or optional column guides), same performance tier as FerriteEditor (cache per table block, recompute on edit — not per-frame full-doc parse).

MVP (v0.3.1)

  • Table block detection — Line-based GFM table regions (header + |---| separator); skip fenced code; reuse outline-style heuristics; optional comrak table node on cache miss for ambiguous blocks.
  • Shared column width cache — Per-tab cache keyed by (start_line, content hash); measure visible cell width (strip inline markdown like rendered serialize_inline_content); invalidate only when that block changes.
  • Column guide overlay (phase 0) — Faint vertical guides at computed column boundaries in Raw; file and cursor unchanged; very low CPU cost.
  • Visual pipe alignment (phase 1) — Draw table rows as positioned segments (| + padded cells) using cached widths; rope buffer stays byte-identical; cursor/selection mapping for table lines (display ↔ raw).

Follow-ups (v0.3.1 if time, else v0.3.2)

  • Galley-accurate widths — Match rendered table layout_no_wrap for proportional fonts (shared helper with EditableTable).
  • Split-view cache warming — Reuse measured widths when rendered table for the same start_line is already laid out.
  • Multi-line / continuation rows — Stress-test tables where one logical row spans multiple source lines (non-standard GFM).

Out of scope: writing padded spaces into the source (TableData::to_markdown()-style formatting on save); full WYSIWYG table grid in Raw (rendered EditableTable remains the edit surface for rich cells).

Docs: add docs/technical/editor/raw-table-alignment.md when implemented; link from docs/technical/editor/architecture.md.

Rendered Markdown Tables — GFM Column Alignment (#140)

Context: TableAlignment is parsed (:---, :---:, ---:) and preserved in TableData / markdown export, but EditableTable forces show_alignment_controls = false and cell text is painted left-aligned only.

  • Render left / center / right per column — Apply alignment in EditableTable cell layout / galley (match GitHub rendered tables).
  • Enable alignment toolbar — Wire with_alignment_controls(true); cycle alignment per column (data model already has cycle_column_alignment).
  • Regression — GitHub docs example table; round-trip through rendered edit session without losing alignment markers.

Multi-Window & Viewports (#125)

Context: Ferrite is single-instance today — a second launch forwards file paths to the primary window. Users want two markdown files visible at once (e.g. compare LLM outputs). egui 0.34 Viewport / show_viewport_deferred APIs are the preferred path post–v0.3.0.

  • Design doc — Multi-window vs in-app dual-document split; impact on AppState, active tab, undo, LSP workspace, and single-instance protocol (allow second window vs secondary instance opens new window).
  • Second OS window with independent tab strip — New viewport hosting a subset of tabs or a cloned workspace; file open routes to focused window.
  • Cross-window file open — Extend single-instance or use per-window listeners so Explorer “Open with” targets the right window when multiple are open.
  • QA matrix — Windows, macOS, Linux X11 + Wayland; z-order, focus, and close semantics.

Follow-up (if capacity): Productivity Hub detached on second monitor via same viewport infrastructure.

Workspace UI — File Tree Polish (#135)

  • Hover states — Visual feedback on file/folder rows and icons in the sidebar tree.
  • Active file emphasis — Clear focus/highlight for the tree row matching the active editor tab.

Window Chrome — Optional Native Decorations (#115) (optional / defer if risky)

  • Settings toggle — “Use system title bar” (default off; keep current borderless custom chrome).
  • Platform behavior — with_decorations(true) on Linux/macOS where requested; document interaction with custom resize/title-bar code on Windows.
  • KDE / Hyprland use case — Respect WM button placement when native decorations are enabled.

Executable Code Blocks — Hardening & Polish

Context: v0.3.0 shipped Run for shell + Python (opt-in, consent, inline ANSI output, timeout, Stop). Manual regression passed on Windows (test_md/test_code_execution.md). Items below are edge cases and polish — not v0.3.0 blockers. Documented limitations: docs/technical/markdown/code-block-run.md § Known limitations.

  • Windows bash / shell fence fallback — When bash is not in PATH, stop reusing bash source for .ps1 / .bat temp files; either fail fast with a clear message (“install Git Bash or use a powershell fence”) or translate/re-dispatch per interpreter.
  • sh / zsh interpreter fallback — Extend shell_interpreters with a sensible platform chain (e.g. sh → bash on Windows; document Unix expectations for zsh).
  • Stable run-state identity — Key inline output / RunHandle by block content hash or AST node id, not start_line alone, so edits above the fence do not orphan output.
  • Running-with-no-output UX — Show a “waiting for output…” placeholder in the inline panel while RunStatus::Running and both streams are empty.
  • Copy / Insert stderr labelling — Prefix stderr in clipboard and ```output insertion to match the on-screen stderr section (or offer a toggle).

Platform & Distribution

Windows

  • Inno Setup installer - Alternative to MSI for users who prefer it; smaller download.

v0.3.2 - LSP, FerriteEditor Crate, Mermaid Crate, GitHub HTML Phase 3 & Format Coverage

Theme: Ship LSP for real (deferred from v0.3.1), extract the text editor and Mermaid renderer as reusable crates, fill in the GitHub HTML rendering tail, and broaden the file-type viewer set.

LSP Integration (All 4 Phases) — Drop the feature flag

Deferred from v0.3.1: capacity reserved for Mermaid wave 2 and multi-window. Code remains in-tree behind the lsp feature flag.

  • Phase 1 fixes: Infrastructure & lifecycle — Backpressure on channels, clear diagnostics on workspace switch, cap transport frame size, join reader threads on shutdown.
  • Phase 1 fix: Incremental document sync — TextDocumentSyncKind::Incremental instead of full-document didChange.
  • Phase 2 fix: Diagnostics panel — Problems panel with click-to-navigate; UTF-16→char column conversion for squiggles.
  • Phase 2 fix: Memory — Stop per-frame diagnostic cloning; bounded event channels; DiagnosticMap cleanup on workspace switch.
  • Phase 3: Hover & Go to Definition — Hover with configurable delay; F12 / Ctrl+Click go-to-def.
  • Phase 4: Autocomplete — Completion popup (Ctrl+Space), debounced, cancellable requests.
  • Settings — Per-language server path override; all processing local.
  • Drop lsp Cargo feature flag — Default feature once Phases 1–2 are field-tested.

FerriteEditor Crate Extraction

Deferred from v0.3.1 to avoid colliding with LSP integration and multi-window refactors. Raw / split-left editing uses src/editor/ferrite/ (~14k lines); undo stays on app Tab.

  • Cargo workspace — New ferrite-editor/ crate (path dep in Ferrite); move src/editor/ferrite/ + minimal EditorWidget glue; keep Ferrite app as integration layer.
  • Decouple app types — Trait or builder hooks for: font family / shaping bytes, syntax highlighting (syntect), fold state, theme colors; optional lsp feature for diagnostic squiggles.
  • Public API — FerriteEditor, TextBuffer, ViewState, LineCache, EditHistory types; ui() entry point; feature flags (vim, lsp, syntax).
  • Examples & docs — examples/minimal.rs (basic egui app); crate README + link from docs/technical/editor/architecture.md.
  • Regression pass — Large files, word wrap, multi-cursor, IME/CJK/complex script, find/replace, code folding, bracket matching.

Out of scope: rendered WYSIWYG crate, headless/non-egui backends (see v0.4.0 long-term).

Mermaid Crate Extraction

  • Standalone crate - Backend-agnostic architecture with SVG, PNG, and egui outputs.
  • Public API - parse(), layout(), render() pipeline.
  • SVG export - Generate valid SVG files from diagrams.
  • PNG export - Rasterize via resvg.
  • WASM compatibility - SVG backend usable in browsers.

Mermaid Improvements — Tail (mmdr-unlocked diagram types)

Conditional on the v0.3.1 mmdr evaluation succeeding.

  • New diagram types (subset of: Sankey, Kanban, Quadrant, XY Chart, C4, Block, Architecture, Requirement, ZenUML, Packet, Radar, Treemap) — pick the most user-requested.

HTML Rendering — GitHub Parity (Phase 3)

  • Phase 3 – Advanced - Nested HTML, HTML tables.

Additional Format Support

XML Tree Viewer
  • XML file support - Open .xml files with syntax highlighting.
  • Tree view - Reuse JSON/YAML tree viewer for hierarchical XML display.
  • Attribute display - Show element attributes in tree nodes.
Configuration Files
  • INI / CONF / CFG support - Parse and display .ini, .conf, .cfg files.
  • Java properties files - Support for .properties files.
  • ENV files - .env file support with optional secret masking.
Log File Viewing
  • Log file detection - Recognize .log files and common log formats.
  • Level highlighting - Color-code ERROR, WARN, INFO, DEBUG.
  • Timestamp recognition - Highlight ISO timestamps and common date formats.

v0.4.0 - Math, Complex Scripts, Office Documents

Theme: Three of the hardest text-rendering problems, taken seriously: native LaTeX math, full RTL/BiDi support, and "page-less" Office document viewing.

Math Rendering Engine

Plan: parse via pulldown-latex (LaTeX → MathML, ~95% KaTeX-compatible, actively maintained); build the MathML→egui layout/render layer ourselves. Avoids reinventing the parser — lets us focus on TeX-style box layout and glyph metrics. See docs/math-support-plan.md for details.

  • LaTeX parser integration - Adopt pulldown-latex (or evaluate math-core) for $...$ inline and $$...$$ display math.
  • MathML → egui layout engine - TeX-style box model (fractions, radicals, scripts, large operators).
  • Math fonts - Embedded glyph subset (Latin Modern Math or STIX) for consistent rendering.
  • egui integration - Render in preview and split views; pick up math automatically in PDF/HTML export.

Supported LaTeX (Target)

  • Fractions, subscripts/superscripts, Greek letters
  • Operators (\sum, \int, \prod, \lim)
  • Roots, delimiters, matrices
  • Font styles (\mathbf, \mathit, \mathrm)

WYSIWYG Features

  • Inline math preview while typing
  • Click-to-edit rendered math
  • Symbol palette

Unicode & Complex Script Support — Phase 3 & 4: RTL, BiDi, WYSIWYG

Depends on: Phase 2 text shaping from v0.2.8. Full RTL+BiDi is one of the hardest problems in text editing; pairing it with the v0.4.0 "complex documents done right" theme rather than rushing it into v0.3.x.

Phase 3: Right-to-Left Layout & Bidirectional Text

  • RTL text layout in FerriteEditor - Render Arabic, Hebrew, and other RTL scripts right-to-left within lines. Shaped glyph runs are placed from the right edge; line alignment respects detected paragraph direction.
  • Unicode BiDi algorithm - Implement the Unicode Bidirectional Algorithm (UAX #9) via the unicode-bidi crate for mixed-direction text (e.g., English embedded in Arabic). Resolves embedding levels, reorders glyph runs per line, and handles directional isolates/overrides.
  • RTL cursor navigation - Arrow keys move in visual order (left arrow moves left visually, regardless of text direction). Home/End respect paragraph direction. Selection handles disjoint byte ranges in BiDi text.
  • RTL selection rendering - Selection highlighting for BiDi text may produce multiple visual rectangles per logical selection range. Click-to-position respects visual glyph boundaries.
  • RTL line wrapping - Word wrap respects script direction. Break opportunities follow UAX #14 (Unicode Line Breaking Algorithm) for correct behavior with Arabic, Hebrew, Thai, and other scripts.

Phase 4: WYSIWYG & UI Chrome

  • Shaped text in WYSIWYG editor - Integrate text shaping into the rendered markdown view (markdown/editor.rs). RichText labels use shaped runs for correct Arabic/Bengali rendering in headings, paragraphs, lists, and tables.
  • Shaped text in Mermaid diagrams - Update TextMeasurer to use shaped advance widths so diagram node labels render complex scripts correctly.
  • UI label shaping - If egui has native shaping by this point (via Parley or direct HarfRust integration), adopt it. Otherwise, provide a shaping wrapper for critical UI surfaces (file tree, outline panel, status bar) where non-Latin file/heading names appear.

Office Document Support (Read‑Only)

DOCX

  • Page-less rendering, text & tables, images
  • Export DOCX → Markdown (lossy, with warnings)

XLSX

  • Sheet selector, table rendering
  • Basic number/date formatting
  • Lazy loading for large sheets

OpenDocument

  • ODT / ODS viewing with shared renderers

FerriteEditor crate extraction is v0.3.2 — see FerriteEditor Crate Extraction.

Future & Long-Term Vision

Core Improvements

  • Persistent undo history - Disk-backed, diff-based history.
  • Memory-mapped I/O (#19) - GB-scale files.
  • TODO list UX - Smarter cursor behavior in task lists.
  • Spell checking - Custom dictionaries.
  • Custom themes - Import/export.
  • Virtual/ghost text - AI suggestions.
  • Column/box selection - Rectangular selection.
  • Accessibility - Full keyboard navigation for all menu items, screen reader support.

Additional Document Formats (Candidates)

  • PDF viewing (read-only) - Page-by-page PDF rendering via native library bindings (PDFium or MuPDF). Requires shipping platform-specific native libraries (~20MB per platform). Complex cross-compilation. Low priority — OS viewers handle this well.
  • Jupyter Notebooks (.ipynb) - Read-only viewing of cells and outputs.
  • EPUB - Page-less e-book reading with TOC and position memory.
  • LaTeX source (.tex) - Syntax highlighting, math preview, outline.
  • Alternative Markup Languages (#21)
    • reStructuredText, Org-mode, AsciiDoc, Zim-Wiki
    • Auto-detection by extension/content

Plugin System

  • Plugin API & extension points
  • Scripting (Lua / WASM / Rhai)
  • Community plugin distribution

Headless Editor Library

  • Framework-agnostic core extraction
  • Abstract rendering backends (egui, wgpu, SVG)
  • Advanced text layout integration (HarfRust/skrifa, with Parley as future option)

Note: These are ideas under consideration.

Recently Completed ✅

v0.3.0 (May 22, 2026) — platform, export, run, diagrams

See [0.3.0] in CHANGELOG.md for the full user-facing list. Highlights:

  • eframe / egui 0.34.2 platform bump (Tasks 57–58, 89; 0.31 → 0.34; MSRV Rust 1.92; skrifa text backend, Popup/Tooltip APIs, HarfRust validation; Windows 0.34 delta regression complete). See eframe-egui-034-upgrade.md.
  • Zero cargo build warnings (Tasks 90–93: ~268 → 0).
  • PDF export (krilla + krilla-svg) and print preview (temp PDF → viewer tab).
  • Themed HTML export with options dialog and Mermaid as SVG.
  • Executable fenced code blocks — Run, shell/Python, ANSI output, timeout + Stop, first-run consent, Settings (opt-in).
  • Quick note workflow (on by default; quit without save dialog, tab close still prompts when modified) and Spanish UI language.
  • Mermaid first wave — insert templates, F1 syntax help, inline validation, flowchart shapes/style, state fork/join + history.
  • Mermaid FC-83a (#83) — flowchart obstacle routing, back-edge side channels, parallel lanes, inner E → B path, branch-parent snap, TD/BT horizontal alignment fix (no left-gap / right-shift in wide containers); docs flowchart-edge-obstacle-routing.md, flowchart-layout-algorithm.md. Still open: FC-83b Font Awesome labels, linkStyle interpolate basis curves (parity matrix).
  • Rendered edit session (Tasks 94–105) — RenderedEditSession coordinator, source_epoch stable widget ids, one-click block switching (headings / paragraphs / lists / formatted / tables), split-view parity, block-commit undo; legacy rendered_focus removed. Docs: rendered-edit-session.md; QA: RS-1…RS-7 in v0.3.0-regression-matrix.md §3.12.
  • Split-view scroll sync — minimap footer Sync / 2-way, content anchors, mode-toggle (Ctrl+E) preservation; docs sync-scrolling.md.
  • Ferrite accent color (Settings + Welcome) and Productivity Hub UI polish (dock/resize/scrollbar, snappy detached window).
  • Search in Files — fixed-height panel; no content-driven vertical growth.
  • Workspace file index — Ctrl+P and Ctrl+Shift+F search all files under the open folder (background walk + progress on large trees); see workspace-file-index.md.
  • Phosphor Icons (egui-phosphor 0.12.0) — unified icon font across app chrome, preview widgets, and data viewers; locale strings deduplicated where icons are rendered in code.
  • Ribbon toolbar — always icon-only (collapse toggle and section labels removed).
  • Undo granularity (raw mode) — per-keystroke Ctrl+Z steps (500 ms merge removed); rendered mode one undo step per block commit (Task 103).
  • CSV rendered view — pixel-width cell truncation so long values stay inside fixed columns (v0.3.0 fix).
  • Notable fixes: smart-paste UTF-8 is_url panic (I-3), consecutive fenced blocks (#129), empty table cell hit-testing (#131), rendered WYSIWYG double-click / stuck edit (Tasks 94–105), table cell focus after typing (session model), split 2-way sync bottom jump (rendered→raw top/bottom delivery path), task list checkbox scroll jump (structure-preserving viewport culling), frontmatter panel stale on tab switch, export menu double icons, outline panel tab hit-testing, crash recovery + cold-start file open, hardened session recovery (Task 106 — identity gating + non-blocking conflict banner closes cross-tab data-loss hazard), disk-hash anchoring across recovery cycles (Task 106.6 — restored tabs anchor original_content to disk so the second restore no longer reverts to pre-first-edit), workspace file index (Ctrl+P / search in collapsed folders), quick file switcher (Ctrl+P) token/recent-file search, quick note save prompt on untitled tab close, per-document view mode restore on reopen, document nav buttons above modal overlays, status-bar Help vs resize corner (I-1), terminal CJK paste/input local-echo with spawn-time UTF-8 init (I-2), Search in Files / detached Productivity Hub panel growth & resize snap, multi-cursor copy/cut, CSV rendered view cell overflow, Mermaid flowchart horizontal alignment (FC-83a), Intel macOS font picker (#133), macOS Gatekeeper doc path (#130). Full list: CHANGELOG.md § 0.3.0 Fixed.

v0.2.9 (Apr 2026) - Hotfix Release

Hotfix for four critical v0.2.8 regressions. No new features.

  • Crash in Split / Rendered view on empty documents (#127) — viewport-culling bootstrap indexed doc.root.children[0] when block_count == 0. Fixed with a half-open render range.
  • No unsaved-changes indicator (*) and no save prompt on close, causing silent data loss — raw-mode edits bypassed content_version, so is_modified() stayed cached at false. content_version bumps centralized in record_edit_from_snapshot() / set_content().
  • Undo / redo reporting "Nothing to undo" after typing — FerriteEditor's internal edits were never diffed into tab.edit_history, which is the stack Ctrl+Z / Ctrl+Y read. Fixed by snapshotting pre-edit content and recording ops per dirty frame.
  • Selection invisible in Light mode (#121) — 40% alpha made the pale light-theme selection blend into the panel. Alpha reduction is now dark-mode-only.
  • Document side panel tab labels overlapping at default width — raised default outline panel width from 200 → 300 px, minimum from 120 → 260 px; existing users auto-migrated by settings validator.

v0.2.8 (Apr 2026) - Performance, Text Shaping, LSP Integration & Viewers

Command Palette (Alt+Space) with fuzzy search across all actions. LSP integration (Phases 1-2): inline diagnostics, server lifecycle, status bar, on-demand startup. HarfRust text shaping for Arabic, Bengali, Devanagari, and other complex scripts. Image viewer tabs (PNG/JPEG/GIF/WebP/BMP) and PDF viewer tabs (hayro, pure Rust). Major rendered view performance overhaul: AST caching, viewport culling, block height cache, lazy estimation. Per-frame O(N) elimination for large files. Background file loading for 5MB+ files. Strict line breaks (Obsidian model). Middle-click to close tabs. CSV/TreeViewer/central panel per-frame allocation fixes. Table cell rich text rendering with click-to-edit (bold, italic, strikethrough, code, nesting). 13 bug fixes including macOS .md file association (#102), Windows IME positioning (#103), custom font crash on Linux (#114), Linux Cinnamon dialog detection (#116), table inline formatting preservation and rendering (#117), terminal CJK rendering (#110), Windows 11 borderless offset (#112), and more.

v0.2.7 (Mar 2026) - Performance, Features & Polish

Wikilinks & backlinks, Vim mode, welcome view, GitHub-style callouts, check for updates, Ctrl+Scroll Wheel zoom, keep text selected after formatting, lazy CSV parsing, large file detection, single-instance protocol, MSI installer overhaul with optional file associations, PortableApps.com Format packaging with automated CI build, Nix/NixOS flake support, German and Japanese localization, Unicode complex script font loading (Phase 1: 11 script families, 22 Unicode ranges), complex script font preferences UI (Settings → Additional Scripts), visual frontmatter editor, format toolbar moved to editor bottom, side panel toggle strip, Linux file dialog error handling with portal failure detection, flowchart modular refactoring, window control redesign, macOS .app bundle CI, task list checkbox rendering, word-wrap scroll correctness & performance fixes, preview list item wrapping fix, false setext heading fix, IME backspace fix (#91), binary file crash fix, rendered mode copy spacing fix, 20+ bug fixes including light mode visibility, scrollbar accuracy, and crash on large selection delete.

v0.2.6.1 (Released Feb 2026) - Terminal, Productivity Hub & Refactoring

First code-signed release. Integrated Terminal Workspace and Productivity Hub contributed by @wolverin0 (PR #74) — the first major community contribution. Major app.rs refactoring into ~15 modules. 8+ bug fixes.

v0.2.6 (Released Jan 2026) - Custom Text Editor

The critical rewrite. Replaced the default egui editor with a custom-built virtual scrolling editor engine.

  • Memory Fixed:
  • Virtual Scrolling: Only renders visible lines; massive performance boost.
  • Code Folding: Visual collapse for code regions.
  • Editor Polish: Word wrap, bracket matching, undo/redo, search highlights.

Prior Releases

  • v0.2.5.x: Syntax themes, Code signing prep, Multi-encoding support, Memory optimizations.
  • v0.2.5: Mermaid modular refactor, CSV viewer, Semantic minimap.
  • v0.2.0: Split view, Native Mermaid rendering.

For detailed logs of all previous versions, see CHANGELOG.md.