Files
vue-tui/packages/runtime-tests/integration/accessibility/screen-reader-live.test.tsx
T
Yunfei He 97c61363e5 fix(runtime): linearize screen-reader static + drop empty-SR-frame newline (Ink parity, G17) (#45)
* fix(runtime): linearize screen-reader static output + drop empty-SR-frame newline (Ink parity, G17)

(a) The live static channel flushed <Static> via the 2D grid painter
(paintIsolated) even in screen-reader mode, so bordered static items leaked
box glyphs. paintStaticNode now takes an isScreenReaderEnabled flag and
linearizes fresh static children via renderScreenReaderOutput
(skipStaticElements:false) instead — matching Ink's renderer.ts:24, which
renders node.staticNode through renderNodeToScreenReaderOutput. Non-SR static
is unchanged. render.ts commit() and render-to-string.ts thread the flag.

(b) Interactive SR frames went through renderInteractiveFrame, which appends
"\n" even for empty output, leaking a spurious blank line. Ink's SR path writes
the wrapped output directly with lastOutputToRender = wrappedOutput (no appended
newline), so an empty SR frame emits zero lines. We now suppress the trailing
newline for EMPTY SR output only — matching ink.tsx:573-626 — leaving non-SR
and non-empty SR frames untouched.

Follow-up fixes (two review findings):
- renderToString in SR mode no longer DROPS <Static> output: the SR return
  branch now prepends the captured/linearized static output like the non-SR
  path (Ink's SR renderer returns staticOutput when node.staticNode exists,
  renderer.ts:24-33).
- The SR static linearization now honors the <Static>'s resolved flexDirection
  for separator + child order (read from yoga via getFlexDirection), matching
  screen-reader.ts:73-82 (row/row-reverse → space, *-reverse reverses order);
  the default column case is unchanged.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

* chore(parity): ledger — G17 pr-open, reconcile G16 merged

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
2026-05-30 04:43:25 +08:00

183 lines
5.5 KiB
TypeScript

import { defineComponent, nextTick } from "vue";
import { expect, test } from "vite-plus/test";
import { Box, createApp, Static, Text } from "@vue-tui/runtime";
import {
makeFakeStdin,
makeFakeWritable,
captureWrites,
getContentWrites,
} from "../lifecycle/test-streams.ts";
// G03 (Ink parity): the LIVE commit path must branch on isScreenReaderEnabled
// and emit the flat, linearized screen-reader text (via renderScreenReaderOutput),
// NOT the 2D grid produced by paint() — which would include border glyphs.
test.sequential("live commit path emits linear screen-reader text (no border glyphs) when SR enabled", async () => {
const App = defineComponent(() => {
return () => (
<Box borderStyle="round">
<Text>Hello world</Text>
</Box>
);
});
const app = createApp(App);
const stdout = makeFakeWritable({ columns: 80 });
const stderr = makeFakeWritable({ columns: 80 });
const { stream: stdin } = makeFakeStdin();
const writes = captureWrites(stdout);
app.mount({
stdout,
stdin,
stderr,
exitOnCtrlC: false,
isScreenReaderEnabled: true,
});
await nextTick();
await nextTick();
const content = getContentWrites(writes).join("");
// The flat text content must be present.
expect(content).toContain("Hello world");
// Border / box-drawing glyphs must NOT appear — SR mode linearizes the tree.
const borderGlyphs = ["╭", "╮", "╰", "╯", "─", "│"];
for (const glyph of borderGlyphs) {
expect(content).not.toContain(glyph);
}
app.unmount();
});
test.sequential("live commit path WITHOUT SR still emits 2D grid with border glyphs (contrast)", async () => {
const App = defineComponent(() => {
return () => (
<Box borderStyle="round">
<Text>Hello world</Text>
</Box>
);
});
const app = createApp(App);
const stdout = makeFakeWritable({ columns: 80 });
const stderr = makeFakeWritable({ columns: 80 });
const { stream: stdin } = makeFakeStdin();
const writes = captureWrites(stdout);
app.mount({
stdout,
stdin,
stderr,
exitOnCtrlC: false,
});
await nextTick();
await nextTick();
const content = getContentWrites(writes).join("");
expect(content).toContain("Hello world");
// Non-SR path renders the visual frame, which DOES contain border glyphs.
expect(content).toContain("─");
app.unmount();
});
// G17 edge (a) (Ink parity): the LIVE static channel must ALSO linearize in SR
// mode. The dynamic frame already excludes <Static> (skipStaticElements:true),
// but commit() flushes statics separately — and previously via the 2D grid
// painter (paintIsolated), so a bordered static item leaked box glyphs even in
// SR mode. Ink linearizes static too: renderer.ts renders node.staticNode via
// renderNodeToScreenReaderOutput({ skipStaticElements:false }).
test.sequential("live static channel emits linear screen-reader text (no border glyphs) when SR enabled", async () => {
const App = defineComponent(() => {
const items = ["Logged in"];
return () => (
<Box flexDirection="column">
<Static items={items}>
{{
default: ({ item }: { item: string }) => (
<Box key={item} borderStyle="round">
<Text>{item}</Text>
</Box>
),
}}
</Static>
<Text>Live</Text>
</Box>
);
});
const app = createApp(App);
const stdout = makeFakeWritable({ columns: 80 });
const stderr = makeFakeWritable({ columns: 80 });
const { stream: stdin } = makeFakeStdin();
const writes = captureWrites(stdout);
app.mount({
stdout,
stdin,
stderr,
exitOnCtrlC: false,
isScreenReaderEnabled: true,
});
await nextTick();
await nextTick();
const content = getContentWrites(writes).join("");
// The flat static text content must be present.
expect(content).toContain("Logged in");
// Border / box-drawing glyphs must NOT appear — the static channel must
// linearize the bordered Box in SR mode just like the dynamic frame.
const borderGlyphs = ["╭", "╮", "╰", "╯", "─", "│"];
for (const glyph of borderGlyphs) {
expect(content).not.toContain(glyph);
}
app.unmount();
});
// G17 edge (b) (Ink parity): an EMPTY SR frame must not write a spurious blank
// trailing line. Ink's SR path writes the wrapped output directly with
// lastOutputToRender = wrappedOutput (NO appended "\n"), and an empty frame is
// "" → height 0, so nothing is emitted (ink.tsx:599-621). The normal frame
// writer appends "\n" even for empty frames, which would leak a blank line.
test.sequential("empty SR frame does not write a spurious blank trailing line", async () => {
const App = defineComponent(() => {
// A Box with no visible text produces an empty linearized SR frame.
return () => <Box />;
});
const app = createApp(App);
const stdout = makeFakeWritable({ columns: 80 });
const stderr = makeFakeWritable({ columns: 80 });
const { stream: stdin } = makeFakeStdin();
const writes = captureWrites(stdout);
app.mount({
stdout,
stdin,
stderr,
exitOnCtrlC: false,
isScreenReaderEnabled: true,
});
await nextTick();
await nextTick();
const content = getContentWrites(writes).join("");
// An empty SR frame must not produce any newline-only / blank write. The
// non-empty case appends a newline via the frame writer; the empty case
// must produce zero output lines (Ink: wrappedOutput === "" writes nothing).
expect(content).not.toContain("\n");
expect(content).toBe("");
app.unmount();
});