fix: grow the hint panel for long prose hints
A long prose hint (insert field-value hints, the parse.usage.* synopses) wrapped but was clipped by the fixed one-row Hint panel, hiding the most useful tail. The candidate list already scrolled horizontally, so only prose was affected. Pre-wrap the prose body and size the Hint panel to the wrapped line count: one row by default, growing to a 3-row cap and reclaiming the space when short, with an ellipsis backstop on the last row. Also shorten the 299-char create-table usage synopsis to a terse one-liner (the full grammar remains under `help`). ADR-0022 Amendment 5.
This commit is contained in:
claude@clouddev1
@@ -642,6 +642,50 @@ example), `advanced_double_precision_classified_as_type`,
|
||||
extended theme mapping/contrast tests. Text snapshots are colour-blind
|
||||
(`render_to_string` strips style), so none churned.
|
||||
|
||||
## Amendment 5 — Hint panel grows for long prose hints (2026-05-29)
|
||||
|
||||
§6 specified a single-row hint panel. A long **prose** hint
|
||||
(field-value hints on `insert`, the `parse.usage.*` synopses) simply
|
||||
didn't fit: the renderer wrapped it but the fixed one-row panel
|
||||
clipped everything past the first line, hiding the most useful tail
|
||||
(issue #12). The candidate-list path was already safe — it scrolls
|
||||
horizontally with `<` / `>` markers (Amendment 2's deferred *two-line
|
||||
candidate box* remains deferred; this amendment does **not** touch
|
||||
candidate rendering).
|
||||
|
||||
**Change:**
|
||||
|
||||
1. **Dynamic height.** `resolve_hint_lines` pre-wraps the prose body
|
||||
to the panel's inner width and `render_right_column` sizes the
|
||||
Hint panel to the line count — one content row by default, growing
|
||||
to `MAX_HINT_ROWS` (3), and reclaiming the space when the hint is
|
||||
short or empty. The candidate list stays one row.
|
||||
2. **Ellipsis backstop.** `clamp_wrapped` caps the wrap at
|
||||
`MAX_HINT_ROWS`; if the hint needs more, the last visible row ends
|
||||
with `…` so overflow is signalled, not silently dropped. (A hint
|
||||
long enough to ellipsize on a narrow terminal fits in full on a
|
||||
wide one.)
|
||||
3. **Shorter `create table` synopsis.** `parse.usage.sql_create_table`
|
||||
was a 299-char "instruction manual" — by far the longest hint
|
||||
string (next was 115). It is now a terse one-liner
|
||||
(`create table [if not exists] <Name> (<col> <type> [constraints],
|
||||
...)`); the exhaustive column- and table-level grammar still lives
|
||||
in `help.ddl.sql_create_table`, reachable via `help`. The
|
||||
`insert.form_b_*` notes (the other long strings) render in the
|
||||
scrollable Output panel, not the Hint panel, so they were left
|
||||
alone.
|
||||
|
||||
**Why 3 rows:** the panel is usually wide (most hints fit one or two
|
||||
rows), and capping at three keeps the Output panel usable; the value
|
||||
can be revisited if hints routinely need more.
|
||||
|
||||
**Coverage:** `long_prose_hint_shows_tail_across_multiple_rows`,
|
||||
`short_hint_keeps_panel_at_one_content_row` (reclaim),
|
||||
`long_hint_grows_panel_but_caps_at_max_rows`,
|
||||
`clamp_wrapped_truncates_with_ellipsis_past_max`, and six re-baselined
|
||||
full-screen snapshots (the empty-state placeholder and the `insert`
|
||||
usage hint now wrap to their full text instead of being clipped).
|
||||
|
||||
## Out of scope
|
||||
|
||||
Deliberately deferred to keep this ADR shippable as a single
|
||||
|
||||
+1
-1
@@ -27,7 +27,7 @@ This directory contains the project's ADRs, recorded per
|
||||
- [ADR-0019 — Friendly error layer (H1) and i18n message catalog](0019-friendly-error-layer-and-i18n.md)
|
||||
- [ADR-0020 — Tokenization layer for the DSL parser](0020-tokenization-layer-for-the-dsl-parser.md)
|
||||
- [ADR-0021 — Parser-as-source-of-truth for H1a (per-command usage in parse errors)](0021-parser-as-source-of-truth-for-h1a.md)
|
||||
- [ADR-0022 — Ambient typing assistance: colour, hint panel, completion (I3 + I4)](0022-ambient-typing-assistance.md) — **Amendment 1 supersedes §12's simple-mode-only carve-out**: the unified mode-aware walker (ADR-0030/0031/0032) now speaks SQL, so advanced-mode ambient assistance is re-enabled. `ambient_hint_in_mode` + `hint_resolution_at_input_in_mode` + `expected_for_hint_snapshot` thread `Mode`; `render_hint_panel` calls ambient for all modes (no more advanced-mode `None`); the one-shot `:` sigil is stripped before the ambient walk. Fixes a live bug where advanced-mode SQL hinting/completion-preview were dead despite Phase 2 marking them green (validated at the engine layer, not the UI). Simple-mode gating, highlighting, and the §13 performance posture are unchanged; covered by an app-level render test plus ambient-layer regression locks; **Amendment 2 reverses the handoff-14 keywords-first candidate ordering** — schema identifiers (table/column/relationship names) now sort *before* keywords so a name the user would have to look up stays visible in the single-row, window-scrolled candidate line (keywords are learned over time; the `tok_identifier`/`tok_keyword` colour split marks the boundary); shipped with a `walk_repeated` fix that surfaces a list item's trailing optionals at a clean boundary (`order by Name ` → `asc`/`desc`, `select Name ` → `as`, `create table … Code(text) ` → `not`/`unique`/`default`/`check`; the `,` separator deliberately not surfaced); records a deferred two-line hint box for growing lists; **Amendment 3 makes the ambient-hint fallback rung schema-aware** — Amendment 1's bottom-rung `parse_command_in_mode` was schemaless while every earlier rung was not, so between-values insert hints pointed at `)` (type-blind close) instead of `,` and wrong-arity closed tuples read "submit with Enter" for an input the schema-aware parse rejects (issue #2); now uses `parse_command_with_schema_in_mode`, no extra walk, with the friendly arity diagnostic still winning at its higher rung; **Amendment 4 gives column types a dedicated highlight class** — both `Node::Ident.highlight_override` *and* the `Word.highlight_override` field were dead (driver destructured the former to `_`, `walk_word` hardcoded `Keyword`); now both wired through, with a new `HighlightClass::Type` + eighth `Theme` field `tok_type` (a pink/deep-magenta distinct from both keyword purple and identifier teal) so types no longer render identically to identifiers (issue #8); the three `IdentSource::Types` slots opt in via `Some(Type)` (advanced-mode single-word SQL aliases — `float`, `varchar`, … per ADR-0035 §3 — ride along for free), and the two-word `double precision` alias opts in via the new `Word::type_keyword` constructor so it matches its synonyms
|
||||
- [ADR-0022 — Ambient typing assistance: colour, hint panel, completion (I3 + I4)](0022-ambient-typing-assistance.md) — **Amendment 1 supersedes §12's simple-mode-only carve-out**: the unified mode-aware walker (ADR-0030/0031/0032) now speaks SQL, so advanced-mode ambient assistance is re-enabled. `ambient_hint_in_mode` + `hint_resolution_at_input_in_mode` + `expected_for_hint_snapshot` thread `Mode`; `render_hint_panel` calls ambient for all modes (no more advanced-mode `None`); the one-shot `:` sigil is stripped before the ambient walk. Fixes a live bug where advanced-mode SQL hinting/completion-preview were dead despite Phase 2 marking them green (validated at the engine layer, not the UI). Simple-mode gating, highlighting, and the §13 performance posture are unchanged; covered by an app-level render test plus ambient-layer regression locks; **Amendment 2 reverses the handoff-14 keywords-first candidate ordering** — schema identifiers (table/column/relationship names) now sort *before* keywords so a name the user would have to look up stays visible in the single-row, window-scrolled candidate line (keywords are learned over time; the `tok_identifier`/`tok_keyword` colour split marks the boundary); shipped with a `walk_repeated` fix that surfaces a list item's trailing optionals at a clean boundary (`order by Name ` → `asc`/`desc`, `select Name ` → `as`, `create table … Code(text) ` → `not`/`unique`/`default`/`check`; the `,` separator deliberately not surfaced); records a deferred two-line hint box for growing lists; **Amendment 3 makes the ambient-hint fallback rung schema-aware** — Amendment 1's bottom-rung `parse_command_in_mode` was schemaless while every earlier rung was not, so between-values insert hints pointed at `)` (type-blind close) instead of `,` and wrong-arity closed tuples read "submit with Enter" for an input the schema-aware parse rejects (issue #2); now uses `parse_command_with_schema_in_mode`, no extra walk, with the friendly arity diagnostic still winning at its higher rung; **Amendment 4 gives column types a dedicated highlight class** — both `Node::Ident.highlight_override` *and* the `Word.highlight_override` field were dead (driver destructured the former to `_`, `walk_word` hardcoded `Keyword`); now both wired through, with a new `HighlightClass::Type` + eighth `Theme` field `tok_type` (a pink/deep-magenta distinct from both keyword purple and identifier teal) so types no longer render identically to identifiers (issue #8); the three `IdentSource::Types` slots opt in via `Some(Type)` (advanced-mode single-word SQL aliases — `float`, `varchar`, … per ADR-0035 §3 — ride along for free), and the two-word `double precision` alias opts in via the new `Word::type_keyword` constructor so it matches its synonyms; **Amendment 5 lets the hint panel grow for long prose hints** — a fixed one-row panel clipped long field-value/usage hints past the first line (issue #12); `resolve_hint_lines` now pre-wraps prose and `render_right_column` sizes the panel to the line count (1 row default, up to `MAX_HINT_ROWS`=3, reclaimed when short) with a `clamp_wrapped` ellipsis backstop; the candidate list still scrolls horizontally on one row (Amendment 2's deferred two-line candidate box stays deferred); also shortens the 299-char `parse.usage.sql_create_table` synopsis to a terse one-liner (full grammar remains in `help.ddl.sql_create_table`)
|
||||
- [ADR-0023 — Unified declarative grammar tree](0023-unified-grammar-tree.md) — direction (superseded for execution detail by ADR-0024)
|
||||
- [ADR-0024 — Unified grammar tree: execution plan](0024-unified-grammar-tree-execution-plan.md) — **Accepted**, the executable spec — implemented (Phases A–F; Phase F shipped "minimal", `parser.rs` retained as the router — see the ADR's Phase F implementation note)
|
||||
- [ADR-0025 — Indexes](0025-indexes.md) — **Accepted** (**Amendment 1, 2026-05-25**: UNIQUE indexes admitted on the **advanced-mode** surface via `CREATE UNIQUE INDEX` — ADR-0035 §4d; the `IndexSchema.unique` flag round-trips through `project.yaml` with no new metadata table since the engine reports uniqueness natively; simple-mode `add unique index` stays deferred), `add index` / `drop index`, persistence, rebuild-table preservation, and items-list display (`C3` index portion + `S2`)
|
||||
|
||||
Reference in New Issue
Block a user