Testowanie

Renderuj aplikacje poza ekranem, naciskaj klawisze i sprawdzaj klatki za pomocą @textjs/app/testing.

@textjs/app/testing (lub @textjs/react/testing) renderuje twoją aplikację poza ekranem, naciska klawisze i zwraca klatkę jako tekst. Testy działają bez przeglądarki ani DevTools.

counter.test.tsxtsx
import { afterEach, expect, test } from "bun:test";import { cleanup, render } from "@textjs/app/testing";import { Counter } from "./counter";afterEach(cleanup);test("counts up", async () => {  const app = await render(<Counter />, { cols: 40, rows: 6 });  await app.press("up up");  expect(app.lastFrame()).toContain("count = 2");});

Działa z każdym narzędziem do uruchamiania testów, które obsługuje testy async, w tym Bun, Vitest i Jest.

Renderowanie

MetodaOpis
render(el, { cols, rows, theme })Montowanie poza ekranem (domyślnie 80×24)
lastFrame()Klatka jako zwykły tekst
lines()Klatka jako tablica wierszy
framesWszystkie dotychczasowe różne klatki
toAnsi()ANSI Truecolor do migawek
cell(x, y){ char, fg, bg, attrs }
locate(text){ x, y } pierwszego dopasowania
rerender(el) / unmount()Aktualizacja lub odmontowanie

renderToString(el, options) renderuje raz i zwraca tekst.

Dane wejściowe

await app.press("down");await app.press("ctrl+k");      // modifiersawait app.press("g g");         // a sequenceawait app.press("G");           // Shift+Gawait app.type("hello\n");      // one key per character, \n is Enterawait app.paste("multi\nline");await app.wheel(3);await app.resize(120, 36);

Każde wywołanie działa wewnątrz act() i przetwarza wynikowe klatki, więc następna asercja widzi aktualizację.

Czas

await app.wait(300);                    // real time passes, then frames flushawait app.waitForText("Deployed");      // poll until the frame contains itawait app.waitFor(() => expect(saved).toBe(true), { timeout: 2000 });

Animacje, wskaźniki ładowania i powiadomienia używają rzeczywistych timerów, więc wait i waitFor pozwalają je wiarygodnie obserwować.

Migawki

expect(app.lastFrame()).toMatchSnapshot();expect(app.toAnsi()).toMatchSnapshot(); // colors too

Klatki są przycinane po prawej stronie i na dole, więc białe znaki nie powodują zmian w migawkach.

Edytuj tę stronę w serwisie GitHub