docs: side-quest-backlog — non-themes deferral inventory

Consolidate the non-themes backlog into docs/side-quest-backlog.md: an
exhaustive, deduplicated index compiled from every framing doc's
"Deferred (named)" section, the handoff §6 list, the roadmap arcs, and a
code-level marker sweep. Organized as side quests (one-shot-ish, led by
the highlighting/detection/LSP/editing families that continue the
#114–#118 stack), raid bosses (vterm, folding, DAP, GPU splits, Jupyter),
cross-cutting substrate blockers, and a prioritization north star.
Themes/faces/color items are excluded (they're the Arc 4 main quest) and
listed once so they're visibly accounted for. Handoff §6 gains a pointer
to it.

Docs only. git diff --check clean.
This commit is contained in:
Levi Neuwirth 2026-07-14 19:10:58 +01:00
parent 5e73966316
commit c51c88cac0
2 changed files with 230 additions and 0 deletions

View File

@ -307,6 +307,9 @@ surface, chrome bold/italic/underline re-shaping).
Housekeeping: F-016 `lua_bindings/mod.rs` split paused mid-way
(tranches 02 landed, ~58 PRs left; see
`docs/lua-bindings-split-framing.md`).
Full cross-cutting index of the non-themes backlog (this list + every
framing doc's Deferred section + a code sweep, themes excluded, with a
prioritization north star): `docs/side-quest-backlog.md`.
## 7. Machine-local facts (desktop) that do NOT travel

227
docs/side-quest-backlog.md Normal file
View File

@ -0,0 +1,227 @@
# Side-quest backlog — the non-themes deferral inventory
**Compiled 2026-07-14** from an exhaustive sweep of every framing doc's
"Deferred (named)" section, the handoff §6 consolidated list, the
`docs/roadmap-2026-07.md` arcs, and a code-level marker sweep
(src/, builtin/, pmacs-gpu/, pmacs-protocol/).
**Scope.** This is the *side-quest* backlog: self-contained,
frontend-agnostic-ish work that does **not** belong to the **themes /
faces main quest** (Arc 4, `docs/theme-faces-framing.md`). Anything about
colors, faces, syntax-highlight *styling*, or semantic-token→color
mapping is excluded here and lives with the theme workstream — those are
listed once, at the bottom, so the reader knows they were seen.
Framing: **side quests** are one-shot-ish and mostly enabling; **raid
bosses** are big multi-PR arcs. Each framing doc's own Deferred section
remains the authoritative per-feature source; this file is the
cross-cutting index. Keep it pruned as items ship.
---
## Side quests — highlighting & language detection
The direct continuation of the #114#118 grammar/detection stack.
- **Locals-query processing** — run each grammar's `LOCALS_QUERY` so
`#is?`/`#is-not? local` is honored (restores `.builtin` styling for
*non-shadowed* console/require etc.), replacing the current
fail-closed drop in `compute_highlight_spans`.
- **Multi-language injections** — the load-bearing enabler. One grammar
per buffer today (`syntax.lua`, "first language wins"); injections
unlock markdown fenced code blocks, HTML-in-JS/CSS, embedded langs,
and per-cell notebooks.
- **Modeline detection** — a 5th detection layer (`-*- mode: … -*-`,
`# vim: ft=…`) after extension → filetype → filename → shebang.
- **JSON + YAML** grammars + LSP (`tree-sitter-json` +
vscode-json-languageserver; yaml-language-server). JSON is also the
prerequisite for the notebook path.
- **More grammars for languages with neither grammar nor LSP** — ruby,
php, html, css, sql, etc.
- **Grapheme / combining-mark awareness** in the text view
(`text_view.rs` skips zero-width marks).
- **Byte-accurate multibyte cursor placement**`move_active_cursor_to`
(and go-to-definition) step one codepoint per LSP byte-column,
landing short on multibyte lines.
- **Daemon query-by-range / incremental highlight**`scoped_style_spans`
runs the query over the whole tree even for a scoped viewport (perf
ceiling on very large files).
## Side quests — LSP feature surface
- **Multi-root scoping** — one server *per project root* instead of the
current first-file-wins single-root-per-language.
- **Hidden-buffer LSP attach** — a restored/registry-only buffer attaches
LSP only on first visit (no `after-load` fires).
- **Inlay-hint inline rendering** — hint data exists but nothing renders;
needs the virtual-text renderer (the cell-overlay model can't reflow
glyphs around inserted columns yet). Plus hint-part interactivity.
- **Completion depth**`completionItem/resolve` + `additionalTextEdits`
(auto-import), snippet tabstops/placeholders, a doc panel beside the
popup, fuzzy matching, persisted frequency ranking.
- **Panels** — reference-row line snippets, in-panel fuzzy filtering,
peek/preview on n/p, call-hierarchy & workspace-symbols panels,
migrate `*buffer-list*` onto `listview`.
- **Quick-fix titles streamed into the context menu** (vs one generic
"Quick Fix" item).
- **Attach transports** — TLS / Custom (SSH landed; these still
parse-and-defer).
## Side quests — editing (Emacs table-stakes not yet built)
- **Kill-ring / motion:** word kills (`M-d`/`M-BS`/`C-BS`/`C-h`/`C-DEL`,
need bytes-returning deleters), `C-SPC` set-mark, `C-u C-y`, `C-M-w`
append-next-kill, kill-ring browser, ring persistence, clipboard
watching.
- **Comments:** block comments + mid-line spans, `comment-dwim`
append-at-EOL, doc-comment continuation on newline, per-language
padding.
- **Auto-indent:** language-aware/electric indent (`indents.scm`),
TAB-as-reindent, `C-o` open-line, `C-j`, strip abandoned-line trailing
whitespace on split.
- **Auto-pairing:** wrap-region on opener, pair-aware backspace,
RET-inside-pair closer-on-own-line, in-string/in-comment inhibit
(needs a node-at-byte `pmacs.parse` binding), undo amalgamation,
balance-aware quotes, per-buffer toggle.
- **Editops:** recenter (`C-l`, blocked on viewport facts), Unicode
case/word classes, region-spanning move/duplicate, locale/numeric
sort-lines, ensure-final-newline on save, punctuation-aware
`fixup-whitespace`, chords for the M-x-only commands.
- **Query-replace:** capture-group refs (`\1`), `,`/`^`/`?` keys,
backward & whole-buffer, single undo-group per run, smart default
from-string, lazy-highlight of remaining matches, non-interactive
`replace-string`/`replace-regexp`.
## Side quests — search
- **Regex + Unicode case-folding** in search (`search.rs` is ASCII-fold,
literal-only today).
- **occur-mode**; **lazy-highlight** of all matches; **search-match
background rendering** on GPU (producer + `SearchMatch` quads).
---
## Cross-cutting substrate (unblocks whole clusters — high leverage)
- **Config/settings registry** (`pmacs.config` / defcustom) — blocks
language-aware indent, the five hardcoded tab-width sites, per-buffer
auto-pair toggle, per-language comment padding, per-project compile
commands.
- **Real `read_only` buffer flag** on both edit paths — true immutability
for panels / REPL / generated buffers.
- **Mode system wiring** — dispatch passes an empty mode list (`&[]`);
mode-scoped keybindings unresolved everywhere.
- **Buffer-aware edit epoch + origin-pinned `after-edit` fan-out** — a
command that edits buffer A then switches to B currently evades
`didChange` / reparse / autosave observers.
- **Undo-group boundaries (`begin/end_undo_group`) + cross-peer
chronological undo arbiter** — coherent multi-edit undo and mixed
source/daemon history.
- **Viewport facts on the wire** — the GPU never consumes daemon
`view_top`; blocks recenter and any scroll command.
---
## Raid bosses (big multi-PR arcs)
- **Arc 5 stage 2 — vterm:** extend `ansi.rs` into a 2D grid model
(alt-screen, cursor addressing, scrollback), grid-backed buffer view,
GPU grid rendering.
- **Arc 6 — Folding:** fold engine (tree-sitter fold ranges) +
`FoldState` wire family + gutter fold markers.
- **Arc 7 — Debugging (DAP):** DAP client (JSON-RPC/stdio, same shape as
the LSP client), breakpoint gutter signs, stack/variables panels
(reuse the Arc 1b listview).
- **Arc 8 — GPU splits / multi-buffer** (largest unscoped design
problem).
- **Jupyter `.ipynb`** — reader → editable → kernel execution; gated on
JSON + injections.
- **Git-diff gutter markers** (needs a diff source; rides the gutter).
---
## Compile-mode / process follow-ups
PTY-mode variant, auto-scroll option, severity threshold for error-only
stepping, per-language/project default commands, echo-area short output
+ distinct `M-&`, error parsing in `*shell-command*`, split-window
display, persist last compile command, next-error across historical
result buffers, occur-mode, configurable `GROUP_TERM_GRACE`, unify the
poll-based cancellable readers across REPL/LSP, fully tick-driven final
drain (kill the ~600 ms teardown stall).
## Persistence & files
Desktop daemon/GPU-attach restore, save unsaved *content* in the desktop,
multiple named desktops, window-local minor state, remote/cross-machine
desktops, non-file buffers in the desktop, saveplace for non-file
buffers, recentf as a `listview` panel, per-project `init.lua` desktop
scoping, newline-in-path handling. **Autosave:** idle-gated timing,
non-file buffers, orphan-recovery GC + browser, offload large writes to a
worker, **external-change guard on `save()` itself** (a real adjacent
bug), a `y_or_n` confirm helper, harden the whole `$XDG_STATE_HOME/pmacs`
root to `0700`, fire `after-load` for `[new file]` buffers. **Files:**
byte-preserving (round-trip-exact) save paths; the *warning* half of
external-change detection (verify-modtime-while-open, revert?).
## GPU frontend mechanics (non-theme)
- **Input:** full command/minibuffer chord forwarding to the GUI,
Meta/Super chords, rebindable local `Ctrl-V`/`Escape`, middle-click
paste, right-click context menu, frontend-local provisional selection.
- **Minibuffer:** `i/total` hint (already on the wire), Telescope-style
preview pane, candidate kind/doc annotations, unify TUI inline vs GPU
dropdown, multibyte-exact band caret, the nav highlight-wrap bug.
- **Scrolling:** scrollbar scroll, pixel-smooth sub-line scroll,
horizontal scroll / soft-wrap.
- **Rendering:** peer caret glyph + name label, own-vs-peer cursor merge,
`SelectionSnapshot` vs `Decorations::Selection` reconciliation,
background-kind decorations actually painted, inline adornment
placements beyond `AtOffset`.
- **Robustness:** auto-reconnect + "reconnecting…" banner, capability
renegotiation (offer to relaunch the daemon `--features crdt`), the
`AttachRequest.initial_size` cell-grid assumption.
- **Perf / harness:** glyphon full-buffer `prepare` ceiling, golden-PNG
comparison harness, `Renderer` sub-struct extraction.
## Packages / protocol / CLI
Forge aliases (`codeberg:` / `forgejo:`, post-v1.0), namespace-preserving
package layout + install-time cross-resolve collision detection,
project-local `init.lua` wiring + after-init calls, multiple files on the
CLI, `describe-job` full-message surfacing.
## Housekeeping / refactor
`lua_bindings/mod.rs` split (~4 tranches / ~14 k lines left; the `theme`
domain excluded — see below), `editor.rs` split (7 k lines),
`pmacs-gpu/src/main.rs` split (6.7 k lines), narrow re-exported
`install_*` from `pub``pub(crate)`.
---
## Excluded — themes / faces main quest (seen, routed elsewhere)
`pmacs.gpu.set_font` + the statusline-segment API; background/selection
theming; per-peer stable presence colors; exact quad colors per
decoration kind; GPU gutter background layer / wash recolor / chrome
bold-italic-underline; current-line highlight refinements; multi-server
semantic-token *style* blending; the compile-mode **severity→color**
classifier (the classification is behavioral, but the coloring is theme
work); the `theme` domain + style/color converters in the lua-bindings
split. Borderline, kept above as mechanics: whitespace glyphs and indent
guides (visual, not color).
---
## North star (highest-leverage first)
Two substrate items unlock the most side quests:
1. **Config registry** — frees ~5 editing/indent/comment features at once.
2. **Multi-language injections** — frees notebooks, markdown code,
embedded langs, and is the honest gate on Jupyter.
After those, the cleanest one-shots in the highlight family are
**JSON/YAML + modeline detection**, and the most-missed editing
table-stakes are **word-kills + `C-SPC` set-mark**.