Skip to content

visual-testing.md

Latest commit

 

History

History
45 lines (31 loc) · 2.63 KB

visual-testing.md

File metadata and controls

45 lines (31 loc) · 2.63 KB
Raw

Visual test matrix

Run this matrix before a release with Pi 0.84 or newer. Record the Pi version, terminal, OS, and result in the release notes or pull request.

Fixture

Install the checkout and select nightfall:

pi install /absolute/path/to/pi-nightfall-theme
pi --theme nightfall

Start a session that includes long wrapped text, headings, links, inline and fenced code, a blockquote, a list, successful and failed tools, a diff, and each available thinking level. Ask for both of these rendered blocks:

```mermaid
graph LR
  A[Night] --> B[Fall]
```

$$\int_0^1 x^2\,dx = \frac{1}{3}$$

For fullscreen checks, use pi --theme nightfall --tui-mode fullscreen, set fullscreenScrollbar to always in /settings, and create enough transcript content to scroll.

Matrix

TUI mode Color capability What to inspect
Regular Truecolor (COLORTERM=truecolor) Text/background contrast, selections, message/tool states, Markdown, syntax, diffs, thinking and bash borders
Fullscreen Truecolor (COLORTERM=truecolor) All regular checks plus fixed dock, scrolling, and the slate scrollbar thumb against the navy background
Regular 256-color (terminal without truecolor, or representative 256-color terminal) Palette fallback keeps text legible and status/diff colors distinguishable
Fullscreen 256-color All 256-color checks plus a visible, non-distracting scrollbar thumb while scrolling

Use at least one modern truecolor terminal and one genuine or configured 256-color environment; merely changing COLORTERM may not override terminal capability detection.

Rendering and export checks

  • Mermaid: confirm labels, lines, and surrounding Markdown remain legible in regular and fullscreen modes; scroll the diagram through fullscreen viewport boundaries.
  • LaTeX: confirm formula glyphs and any image rendering have adequate contrast in both modes. In fullscreen, use a Kitty-protocol terminal such as Kitty or Ghostty for inline images; where unsupported, verify the text placeholder is readable.
  • HTML: run /export nightfall-check.html, open the file in a browser, and inspect page (pageBg), cards (cardBg), info sections (infoBg), text, Markdown, code, and diagrams. Confirm no unresolved variable names appear as CSS colors.
  • Resize: at narrow and wide terminal widths, check wrapped content and ensure selections, borders, diagrams, formulas, and the fullscreen thumb are not clipped unexpectedly.

A release passes only when every applicable cell and rendering check has been inspected; document terminal-specific exceptions rather than silently skipping them.