Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c59ccce32b | ||
|
|
c24049c443 | ||
|
|
cefeb8059a | ||
|
|
078902710b | ||
|
|
46ff99aad1 |
No files matched your search
@@ -3,29 +3,29 @@
|
||||
Explore maps your app: a screenshot of every screen, connected by the taps between them. On each pull request it captures the screens the PR changes, before and after, on EAS Simulator, and posts a visual review. On your Mac it can also run on a local simulator.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-hero-dark.png">
|
||||
<img alt="Explore's Map of a euxy pull request, zoomed in on the new About screen, marked Added among the modified Patterns screens, with its transitions highlighted and the Inspector open on it, shown as a window on a soft stage" src="docs/screenshots/readme-hero-light.png">
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-hero-dark.svg">
|
||||
<img alt="Explore's Map of a euxy pull request, animated: the screen cards appear row by row, the new About screen marked Added among the modified Patterns screens, the transitions between them wipe in, then a click selects About, its transitions light up and the Inspector slides in on it, shown as a window on a soft stage" src="docs/screenshots/readme-hero-light.svg">
|
||||
</picture>
|
||||
|
||||
**See a real report:** [euxy](https://explore-example--euxy.expo.app/p/rfcoic27ccgnrmzgijubxkmuzmptcrva?platform=ios), a MIDI sequencer, reviewed by Explore. It is redeployed with the current Viewer on every merge to main.
|
||||
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-compare-dark.svg">
|
||||
<img alt="The euxy Patterns screen wiping from its capture before the pull request to its capture after it: each pattern row's tempo moves out of the subtitle into its own column on the right, then the changed subtitles are outlined" src="docs/screenshots/readme-compare-light.svg">
|
||||
</picture>
|
||||
|
||||
**Compare**: each changed screen before and after, with the changed regions outlined.
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td width="33%" valign="top">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-compare-dark.png">
|
||||
<img width="100%" alt="The Compare view with the euxy Patterns screen's before and after captures side by side: each pattern row's tempo moved out of the subtitle into its own column on the right, the changed subtitles outlined in both" src="docs/screenshots/readme-compare-light.png">
|
||||
</picture>
|
||||
<strong>Compare</strong>: each changed screen before and after, with the changed regions outlined.
|
||||
</td>
|
||||
<td width="33%" valign="top">
|
||||
<td width="50%" valign="top">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-screens-dark.png">
|
||||
<img width="100%" alt="The Screens view of a euxy review: the app/ route tree on the left under Changed 9 and All 19, and a grid of screen cards beside it in the same order, each with its route below the screenshot and a dot before it: green for the new /about, orange for modified screens such as /activity-log, /settings and /patterns, red for the removed /channel-surf" src="docs/screenshots/readme-screens-light.png">
|
||||
</picture>
|
||||
<strong>Screens</strong>: every capture in one grid, beside the route tree, with a dot for what changed.
|
||||
</td>
|
||||
<td width="33%" valign="top">
|
||||
<td width="50%" valign="top">
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="docs/screenshots/readme-pr-comment-dark.png">
|
||||
<img width="100%" alt="Explore's GitHub PR comment on a euxy PR: the heading links to the iOS and Android reports, a table with one row per platform giving device, result and an Open link, the Added, Removed, Modified, Needs review and Source-affected screens as collapsed lists, fading out below them" src="docs/screenshots/readme-pr-comment-light.png">
|
||||
@@ -80,7 +80,10 @@ describes, never for a password in chat. Open the report, and if I need to log i
|
||||
something first, tell me the command.
|
||||
```
|
||||
|
||||
You need Node.js 24.12+. Reviewing a change needs an Expo account and an Expo SDK 57+ app with Expo Router or React Navigation: it is built on EAS and captured on EAS Simulator ([join the waitlist](https://expo.dev/services/simulators)) or, with Xcode, on a simulator on your Mac. Exploring a build needs a Claude Code or Codex login, and EAS Simulator or a simulator on your Mac; on your Mac, no Expo account. No API keys, no CI.
|
||||
You need Node.js 24.12+. Reviewing a change needs an Expo account and an Expo SDK 57+ app with Expo Router or React Navigation: it is built on EAS and captured on EAS Simulator or, with Xcode, on a simulator on your Mac. Exploring a build needs a Claude Code or Codex login, and EAS Simulator or a simulator on your Mac; on your Mac, no Expo account. No API keys, no CI.
|
||||
|
||||
> [!NOTE]
|
||||
> EAS Simulator is in preview. [Join the waitlist](https://expo.dev/services/simulators), or pass `--simulator local` to capture on a simulator on your Mac.
|
||||
|
||||
<details>
|
||||
<summary><strong>Run it yourself</strong></summary>
|
||||
@@ -123,6 +126,9 @@ Explore starts an EAS Simulator, installs the build, taps through the app with y
|
||||
|
||||
</details>
|
||||
|
||||
> [!WARNING]
|
||||
> A review runs both commits' code on your machine, as you: it installs their dependencies, evaluates the app config and bundles the JavaScript. Review only commits you would run yourself, and someone else's branch only if you trust it.
|
||||
|
||||
Every run is kept on your machine for 30 days. `npx @expo/explore reports` lists your local reviews, explorations and uploaded reports with their commits, and reopens or hosts one without capturing again:
|
||||
|
||||
<picture>
|
||||
@@ -141,7 +147,6 @@ npx @expo/explore capture --base v1.3.0 --head v1.4.0 --scope all --upload
|
||||
|
||||
- It checks out both commits as temporary worktrees, installs their dependencies, captures every configured platform or [target](#targets) on EAS Simulator or a [local simulator](#simulator), and opens the report in a local Viewer. `--target` or `--platform` picks some; they run at once, at most `--parallel N` at a time. `--upload` hosts it for 30 days (`--expires-in` changes that) and prints the link; `report:upload <report.zip>` hosts one you already have.
|
||||
- Your checkout, index and branches are never touched. Your uncommitted changes, untracked files included, are reviewed as `eas build` would upload them; `--committed`, or `cli.requireCommit: true` in `eas.json`, leaves them out.
|
||||
- It runs both commits' code on your machine, as you: installing their dependencies, evaluating the app config, and bundling the JavaScript. That is what checking them out and running them would do, so review only commits you would run, and someone else's branch only if you trust it.
|
||||
- Installs run without credential environment variables, which keeps tokens out of reach of a registry a commit's `.npmrc` names; that is not a sandbox. A registry that needs `${NPM_TOKEN}` in the project's `.npmrc` must be authenticated in your own `~/.npmrc`.
|
||||
- Captures are cached in `~/.cache/expo-explore`, so the same base is not captured twice (`--no-cache` skips it); a capture unused for 30 days goes, and the cache stays under 2 GB. Ctrl+C stops the run's simulator sessions and local devices; when a run is stopped harder than that, the next local run stops what it left running.
|
||||
- Like a CI review, it builds on EAS (reusing a matching build) and, unless it captures on a local simulator, runs EAS Simulator sessions: expect several minutes and EAS usage.
|
||||
@@ -512,11 +517,28 @@ curl -s "$LINK/api/v1/screens?status=modified" | jq '.items[] | {route, status,
|
||||
<details>
|
||||
<summary><strong>How it works</strong></summary>
|
||||
|
||||
1. The review workflow runs on open, non-draft PRs from the repository whose author has write access. Bots such as Devin go under `ci.trustedAuthors` in `.expo-explore/config.yaml`.
|
||||
2. Explore reads the diff and your router source to pick the affected screens.
|
||||
3. It builds both revisions on EAS (reusing a build with the same native fingerprint) and captures each screen on EAS Simulator (or, on your machine, a local simulator), reusing a baseline of the base commit when one exists. If EAS fails to start a session, Explore starts a new one, up to five times within 30 minutes.
|
||||
4. It compares the captures. A screen with a source change is **Modified** if its captures differ.
|
||||
5. It uploads the report to GitHub Actions and posts a PR comment.
|
||||
```mermaid
|
||||
sequenceDiagram
|
||||
autonumber
|
||||
participant PR as Pull request
|
||||
participant GA as GitHub Actions
|
||||
participant B as EAS Build
|
||||
participant S as EAS Simulator
|
||||
PR->>GA: opened or updated
|
||||
GA->>GA: read the diff and router source, pick the affected screens
|
||||
GA->>B: build base and head
|
||||
Note over B: reuses a build with the same native fingerprint
|
||||
B-->>GA: simulator builds
|
||||
GA->>S: capture each affected screen, in each appearance
|
||||
Note over S: the base reuses its baseline when one exists
|
||||
S-->>GA: screenshots
|
||||
GA->>GA: compare the captures, outline the changed regions
|
||||
GA->>PR: upload the report, comment with its links
|
||||
```
|
||||
|
||||
- The review workflow runs on open, non-draft PRs from the repository whose author has write access. Bots such as Devin go under `ci.trustedAuthors` in `.expo-explore/config.yaml`.
|
||||
- A screen with a source change is **Modified** if its captures differ.
|
||||
- If EAS fails to start a session, Explore starts a new one, up to five times within 30 minutes. On your machine, a local simulator can stand in for EAS Simulator.
|
||||
|
||||
The same review runs for any two commits without a PR ([`explore-compare.yml`](#compare-any-two-commits), linking the report from the run summary) and on your machine (`capture`, [above](#quick-start)). The workflows' logic lives in `expo-explore ci:*` commands, so a fix reaches CI with the `@expo/explore` version the workflows pin.
|
||||
|
||||
|
||||
@@ -362,6 +362,16 @@ Capture uses the automatic GitHub token with `pull-requests: write`, so it can k
|
||||
|
||||
The sticky comment is one comment for the whole run: a header with the base and head commits, one row per captured platform (device, result, **Open** / **zip** / **run** links), every changed screen listed once with a link per platform, and a collapsed validation table with one column per platform. Each platform's job updates only its own hidden record in the comment, so iOS and Android jobs never overwrite each other. When a new run starts (a push, a rerun), the earlier run moves to a collapsed **Previous runs** list that keeps its head commit, result, report and run links; the last five runs are kept. A run that finishes after the PR moved on is still published, under previous runs, instead of failing. The failure job posts through the same renderer (`ci:failure`), so a crash before the pipeline's own comment still lands in that platform's row.
|
||||
|
||||
The comment can also draw a map of the change: the added, removed and visually changed screens, the screens one step before them, and the transitions among them, as a collapsed Mermaid flowchart that GitHub draws in place. It is off by default; turn it on with:
|
||||
|
||||
```yaml
|
||||
report:
|
||||
comment:
|
||||
map: true # default false
|
||||
```
|
||||
|
||||
The map leaves out screens whose source changed but whose captures match, and it is skipped when more than 30 routes changed or when the comment would be over GitHub's size limit.
|
||||
|
||||
PR review links always use [explore-preview.expo.app](https://explore-preview.expo.app/); no viewer-origin variable is needed or accepted by the CI publisher. Reports stay in GitHub Actions: the comment's **zip** link fetches the `explore-review-<run>-<attempt>.zip` artifact (GitHub asks for sign-in and repository read access), and the page that **Open** opens takes that ZIP by drag-and-drop or **Choose file**. Nothing is enabled per repository on Expo's side. See [report access](private-review.md).
|
||||
|
||||
Credentialed capture accepts open, non-draft, same-repository PRs whose authors have current write access, or are listed under `ci.trustedAuthors` in the default branch's `.expo-explore/config.yaml` (for bots such as `devin-ai-integration[bot]`). Fork PRs cannot receive capture credentials. Tools are loaded from the pinned reviewed commit, not the PR checkout. Build execution still runs the authorized application's code.
|
||||
|
||||
|
Before Width: | Height: | Size: 451 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1000 600" width="1000" height="600" role="img" aria-label="The /patterns screen of euxy wiping from its capture before the pull request to its capture after it, with the changed regions outlined"><style>.after{animation:wipe 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes wipe{0.00%{clip-path:inset(0 100% 0 0)}14.29%{clip-path:inset(0 100% 0 0)}37.14%{clip-path:inset(0 0 0 0)}82.86%{clip-path:inset(0 0 0 0)}97.14%{clip-path:inset(0 100% 0 0)}100.00%{clip-path:inset(0 100% 0 0)}}.divider{opacity:0;animation:divider 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes divider{0.00%{transform:translateX(0);opacity:0}11.43%{transform:translateX(0);opacity:1}14.29%{transform:translateX(0);opacity:1}37.14%{transform:translateX(248px);opacity:1}41.43%{transform:translateX(248px);opacity:0}82.86%{transform:translateX(248px);opacity:0}85.71%{transform:translateX(248px);opacity:1}97.14%{transform:translateX(0);opacity:1}100.00%{transform:translateX(0);opacity:0}}.regions{animation:regions 7s ease-in-out infinite}@keyframes regions{0.00%{opacity:0}38.57%{opacity:0}44.29%{opacity:1}51.43%{opacity:.3}58.57%{opacity:1}81.43%{opacity:1}85.71%{opacity:0}100.00%{opacity:0}}.before-label{opacity:.3;animation:before-label 7s linear infinite}.after-label{animation:after-label 7s linear infinite}@keyframes before-label{0.00%{opacity:1}25.71%{opacity:1}28.57%{opacity:.3}88.57%{opacity:.3}91.43%{opacity:1}100.00%{opacity:1}}@keyframes after-label{0.00%{opacity:.3}25.71%{opacity:.3}28.57%{opacity:1}88.57%{opacity:1}91.43%{opacity:.3}100.00%{opacity:.3}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><clipPath id="stage"><rect width="1000" height="600" rx="16"/></clipPath><clipPath id="phone"><rect x="376" y="30" width="248" height="540" rx="40"/></clipPath><filter id="shadow" x="-20%" y="-20%" width="140%" height="140%"><feDropShadow dx="0" dy="8" stdDeviation="14" flood-color="rgba(1,4,9,0.6)"/></filter></defs><g clip-path="url(#stage)"><rect width="1000" height="600" fill="#151B23"/><rect x="376" y="30" width="248" height="540" rx="40" fill="#151B23" filter="url(#shadow)"/><g clip-path="url(#phone)"><image href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAYEBAUEBAYFBQUGBgYHCQ4JCQgICRINDQoOFRIWFhUSFBQXGiEcFxgfGRQUHScdHyIjJSUlFhwpLCgkKyEkJST/2wBDAQYGBgkICREJCREkGBQYJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCT/wAARCANqAZIDASIAAhEBAxEB/8QAHAABAAICAwEAAAAAAAAAAAAAAAMFBAYBAgcI/8QAWBAAAQMDAQQECwQHBAUKBQQDAQACAwQFERIGEyExFEFR0QcVIjJSU2GBkZKTNFRxsQgjM2OhouEWQmLBJHJ1gtIYNkNVVrKz1OLwFzdzlJUmNThEg8Px/8QAGAEBAQEBAQAAAAAAAAAAAAAAAAEDAgT/xAAdEQEBAAMBAAMBAAAAAAAAAAAAEQECAwQSMUFR/9oADAMBAAIRAxEAPwD5UREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBFs2wdn2aut0kftXeZrbbaZgkdHTRa6ircXACKIHgHHOdTuAAXptz8CuzVB4X9sLRPUXCHZPZS3suVSWva6olbuI37priManOecHHIY9qDwxF6dtdsfspd/B5Dt9sZT19sp4Lj4suNurZxPuXFupkrHhoJaRwII5nhy449DsjsFs/tZc6faXa2K8Wm3UQqIDZ8g3KcgEQNeQQzBJy49nUeQecovVdtdiNjpdktlNsrGa/Z2gvVdJQ1NLXvNTuGscA6eNzWhz2AZyMZzwCu6fYTwZbVWvaaLZ2j2lo4rHbpa2n2jrZR0atdHgBroyxujWT5IB1ezIwg8PREQEREBERAREQEREBERAREQEREBERAREQEREBERAREQEReh+C3YDZbaenr7xthtdDZLXb3sjdSwDXW1TneaImYPPB4gO4jl1oPPEX0xUeDTwVMt5kqvB34VrbQacm7vpc7tvrHMy4hvXnR7l414T9iLNsXdaQbP7U0O0druEHSaeaA4ljZnGmVv913A+3gcgckGmIvQPA/4M5PCZtDFao5IY3SF+XzaiyJjG5c4hpBceLQACOJ4ngve/wDkWUn/AGlt3/4qf/ziD5ERfXf/ACLKT/tJbv8A8VP/AOcXgHhU8GtT4P8AaOstGGSvpHfrHQajG5hYx7ZAHZLQQ8Agk4IPEhBoaIiAiIgIiICIiAiIgIiIJaRwZVQucQAHtJJ6uK+jL54QNlLp4afCLQTXyljsW1tqit8F2YdcMM7aeIMc4j+4HBwJ6j2DJXzciD17aipsuwXgiOwlNtBar/d7rdm3GsltMxmp6eBjNLGCTABeSM+zjnqzjbJbPeC7a3wkSOddp9ntkKWGObc3ioa2eqeAAYg9uQ0F2SSMkDlgnh5UiD2HwsNprxe7Vc7xtlsxWWKKojoIbTs1O6R1so+JJjY6NoOA3ieZcR1YxttnqLBsfZ7xS3vwmWLarYQ0M8dssYeZqt0jsmI7osG4e0k+UCME9XV84ogIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgszQ2/pMEfTsxvYS93onsURpaPo1TJ0r9ZHIWxtx57e1YKIMuvp6aDddGqN9qbl3+ErI2a2iuGyV+ob7aZWRV1DKJYXPYHgEdoPAjGQqxEH0HV+HF9u2Lt+1Nr8I21VXttUTaaq01W7dQMx553OjS1mCNJack9mDjwKsq5q+rnq6l+ueeR0sjsAanOOScDgOJ6lCiD1DwD+Eel8HG1ENzqoRPGzeMki3jY3Pje0AlrnEN1AtacOIBGeIX0t/yuNiP+rLz9eg/80vhlEH3N/wArjYj/AKsvP16D/wA0vmbwzeEwbb7WXC7UDRTMrf1Zia9shZCGRsDXOHAuOgk6SQMgZPFeZIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIiICIiAiIgIilhpZ6jO6ie/HMgcB+JQRIsw2qrAzu2fUb3rHlp5YDiSNzOzI5oI0REBERARSw0s9RndRPfjmQOA/Eqc2qLine truncated
|
||||
|
After Width: | Height: | Size: 107 KiB |
|
Before Width: | Height: | Size: 452 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1000 600" width="1000" height="600" role="img" aria-label="The /patterns screen of euxy wiping from its capture before the pull request to its capture after it, with the changed regions outlined"><style>.after{animation:wipe 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes wipe{0.00%{clip-path:inset(0 100% 0 0)}14.29%{clip-path:inset(0 100% 0 0)}37.14%{clip-path:inset(0 0 0 0)}82.86%{clip-path:inset(0 0 0 0)}97.14%{clip-path:inset(0 100% 0 0)}100.00%{clip-path:inset(0 100% 0 0)}}.divider{opacity:0;animation:divider 7s cubic-bezier(.65,0,.35,1) infinite}@keyframes divider{0.00%{transform:translateX(0);opacity:0}11.43%{transform:translateX(0);opacity:1}14.29%{transform:translateX(0);opacity:1}37.14%{transform:translateX(248px);opacity:1}41.43%{transform:translateX(248px);opacity:0}82.86%{transform:translateX(248px);opacity:0}85.71%{transform:translateX(248px);opacity:1}97.14%{transform:translateX(0);opacity:1}100.00%{transform:translateX(0);opacity:0}}.regions{animation:regions 7s ease-in-out infinite}@keyframes regions{0.00%{opacity:0}38.57%{opacity:0}44.29%{opacity:1}51.43%{opacity:.3}58.57%{opacity:1}81.43%{opacity:1}85.71%{opacity:0}100.00%{opacity:0}}.before-label{opacity:.3;animation:before-label 7s linear infinite}.after-label{animation:after-label 7s linear infinite}@keyframes before-label{0.00%{opacity:1}25.71%{opacity:1}28.57%{opacity:.3}88.57%{opacity:.3}91.43%{opacity:1}100.00%{opacity:1}}@keyframes after-label{0.00%{opacity:.3}25.71%{opacity:.3}28.57%{opacity:1}88.57%{opacity:1}91.43%{opacity:.3}100.00%{opacity:.3}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><clipPath id="stage"><rect width="1000" height="600" rx="16"/></clipPath><clipPath id="phone"><rect x="376" y="30" width="248" height="540" rx="40"/></clipPath><filter id="shadow" x="-20%" y="-20%" width="140%" height="140%"><feDropShadow dx="0" dy="8" stdDeviation="14" flood-color="rgba(17,17,17,0.14)"/></filter></defs><g clip-path="url(#stage)"><rect width="1000" height="600" fill="#F6F8FA"/><rect x="376" y="30" width="248" height="540" rx="40" fill="#F6F8FA" filter="url(#shadow)"/><g clip-path="url(#phone)"><image href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9YWVogAAAAAAAA9tYAAQAAAADTLXBhcmEAAAAAAAQAAAACZmYAAPKnAAANWQAAE9AAAApbAAAAAAAAAABtbHVjAAAAAAAAAAEAAAAMZW5VUwAAACAAAAAcAEcAbwBvAGcAbABlACAASQBuAGMALgAgADIAMAAxADb/2wBDAAYEBAUEBAYFBQUGBgYHCQ4JCQgICRINDQoOFRIWFhUSFBQXGiEcFxgfGRQUHScdHyIjJSUlFhwpLCgkKyEkJST/2wBDAQYGBgkICREJCREkGBQYJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCT/wAARCANqAZIDASIAAhEBAxEB/8QAHQABAAEFAQEBAAAAAAAAAAAAAAECAwQFBgcICf/EAFkQAAEDAwICBwQHBAYFCgQDCQEAAgMEBREGEiExBxMUQVFSkSIyYaEVM1NxgZLhCCNisRgkNELR0xZWlJXBJTdDcnN1gqKz8Bdjk9QmNTY4RlV0g4Sy0vH/xAAYAQEBAQEBAAAAAAAAAAAAAAAAAQIDBP/EABoRAQEBAQEBAQAAAAAAAAAAAAARAQIDIQT/2gAMAwEAAhEDEQA/APpxERFEREBERAREQEREBERAREQEREBERARYl0u9uslI6sulfSUFMz3pqmVsbB+LiAuCuH7RnRXbZDHNq6mkcOH9XgmmHqxhHzQekIvKv6UPRP8A6zSf7vqf8tP6UPRP/rNJ/u+p/wAtB6qi8q/pQ9E/+s0n+76n/LT+lD0T/wCs0n+76n/LQeqovKv6UPRP/rNJ/u+p/wAtP6UPRP8A6zSf7vqf8tB6qi8q/pQ9E/8ArNJ/u+p/y0/pQ9E/+s0n+76n/LQeqovKv6UPRP8A6zSf7vqf8tP6UPRP/rNJ/u+p/wAtB6qi8vpv2mOiipeGN1W1hP2lFUMHqY8Lt9O6z03q2IyWG+W65hoy4U07XuZ/1mg5H4hBuUREBERAREQEREBERAREQEREBERAREQEREBERAREQEREBFq9TXK4Wix1NZabTJeK9m1sFFHIIzK9zg0ZceDWjOSe4Aryaz9NOobTofXl91ZTW2W4aauLqCKChDmxPkO1rW5JJI3uHHngIPbUXkdFq/X+jdTaYpNcVFor6DUzzTf1KndC+3VRbubHkuO9p93J48M93HprprLVD7Vqf6F0ZXPudrnbTW9lW5rIrhuIHWtOR7DcknjxAxnOQA7ZF5PZ9Va6030lWLSOqrjZ73HfaSeoD6GmMD6F0TdxyMndGfdBOCT4YwadM9I2trl0s02nb9Z6KzWyutUlxpqPcZKpjWybGmVwO0OOCdoHAEDOcoPWkREBERAXE9LvSdQ9FWkZbzUMbUVkrupoqUnHXSkZ4+DQOJP4cyF2y+MP2wtRT3LpIpbNvPZrVRM2s7usk9pzvxb1Y/BB5NrLXWodfXZ901DcpqyZxOxhOI4R5WN5NH3fjkrQIiIIiICIiAiIgIiICIiAsm3XKttFbFXW+rno6qF26OaCQsew+II4hYyIPtX9nDp2m6RaaTTuopGfT9HH1kc4AaK2IcCcDgHt4ZxzBz3Fe5L83ujTUU+k9f2C8wPLDTVsW/H96Nztr2/i0uH4r9IUUREQEREBEXn/AEn681RpmooLRpHSc15udwY97aqc7KKla3mZH5HLI4Et4Hn3IPQEXzbT9JHSk+vEdL0g9Flyrt3C0sqcb3fZtfhoLu7G/wDFew9GetbxrK11Zv8Apiu09c6Cfs1RDOMxSOxndE7+83iPhxGCeaDsUXBdLnSTH0bWCW6SRyyNjDcMh2h8r3uw1oLgQ0cHEkg8BwHFeEf0y6r/AFcuH+9IP/tEH1oi+TP6ZdV/q5cP96Qf/aL3rou6R6bXunaS7ZfEyrb+7bPtEjXhz2ujJbgOILCQQBkEcAUHcoiICIiAiIgIiICIiAiIgLwGp6ML/qTSPSxZ+xS0lVdL/JXW0zjY2oDHMe0tJ4YdtLc8uK9+RB4pPUak6WdV6LbU6RvNgpNP1QudznuUIiY6oY3DI4eJ6wF2fa8F2t0uut9MWrVF1qKCl1AWTA2S321jhMYzhoEue8E5OM8A74AdsiDxHogq7jBqB9x1Lo3V79U3r2a281tGxlLSsALhDH7ZLIhgAcMuOCe7HS3CxXOT9oK13xlDO62Radlpn1Yb+7bKZiQwnxxxwvSUQEREBERAXxV+19Yprd0ox3NzD1FzoYnsf3FzMsc37wA0/wDiC+1VLine truncated
|
||||
|
After Width: | Height: | Size: 109 KiB |
|
Before Width: | Height: | Size: 847 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1600 900" width="1600" height="900" role="img" aria-label="Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects /about and the Inspector opens on it"><style>.c0{transform-origin:0 0;animation:c0 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c0{0.00%{opacity:0;transform:scale(.92)}4.33%{opacity:0;transform:scale(.92)}8.08%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c1{transform-origin:0 0;animation:c1 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c1{0.00%{opacity:0;transform:scale(.92)}4.00%{opacity:0;transform:scale(.92)}7.75%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c2{transform-origin:0 0;animation:c2 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c2{0.00%{opacity:0;transform:scale(.92)}4.67%{opacity:0;transform:scale(.92)}8.42%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c3{transform-origin:0 0;animation:c3 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c3{0.00%{opacity:0;transform:scale(.92)}6.08%{opacity:0;transform:scale(.92)}9.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c4{transform-origin:0 0;animation:c4 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c4{0.00%{opacity:0;transform:scale(.92)}6.41%{opacity:0;transform:scale(.92)}10.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c5{transform-origin:0 0;animation:c5 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c5{0.00%{opacity:0;transform:scale(.92)}6.75%{opacity:0;transform:scale(.92)}10.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c6{transform-origin:0 0;animation:c6 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c6{0.00%{opacity:0;transform:scale(.92)}7.08%{opacity:0;transform:scale(.92)}10.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c7{transform-origin:0 0;animation:c7 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c7{0.00%{opacity:0;transform:scale(.92)}3.66%{opacity:0;transform:scale(.92)}7.41%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c8{transform-origin:0 0;animation:c8 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c8{0.00%{opacity:0;transform:scale(.92)}7.41%{opacity:0;transform:scale(.92)}11.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c9{transform-origin:0 0;animation:c9 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c9{0.00%{opacity:0;transform:scale(.92)}7.75%{opacity:0;transform:scale(.92)}11.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c10{transform-origin:0 0;animation:c10 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c10{0.00%{opacity:0;transform:scale(.92)}8.08%{opacity:0;transform:scale(.92)}11.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c11{transform-origin:0 0;animation:c11 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c11{0.00%{opacity:0;transform:scale(.92)}8.42%{opacity:0;transform:scale(.92)}12.17%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.full{animation:full 12s cubic-bezier(.45,0,.25,1) infinite}@keyframes full{0.00%{clip-path:inset(0 0 100% 0)}10.83%{clip-path:inset(0 0 100% 0)}21.67%{clip-path:inset(0 0 0 0)}100.00%{clip-path:inset(0 0 0 0)}}.ptr{opacity:0;animation:ptr 12s cubic-bezier(.4,0,.2,1) infinite}@keyframes ptr{0.00%{opacity:0;transform:translate(978.5px,714.0px)}25.83%{opacity:0;transform:translate(978.5px,714.0px)}27.50%{opacity:1;transform:translate(978.5px,714.0px)}35.83%{opacity:1;transform:translate(718.5px,505.2px)}36.67%{opacity:1;transform:translate(718.5px,505.2px) scale(.82)}37.92%{opacity:1;transform:translate(718.5px,505.2px)}45.83%{opacity:0;transform:translate(718.5px,505.2px)}100.00%{opacity:0;transform:translate(718.5px,505.2px)}}.sel{animation:sel 12s ease-out infinite}@keyframes sel{0.00%{opacity:0}36.67%{opacity:0}39.17%{opacity:1}100.00%{opacity:1}}.insp{animation:insp 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes insp{0.00%{opacity:0;transform:translateX(48px)}37.08%{opacity:0;transform:translateX(48px)}42.08%{opacity:1;transform:translateX(0)}100.00%{opacity:1;transform:translateX(0)}}.cover{opacity:0;animation:cover 12s linear infinite}@keyframes cover{0.00%{opacity:1}1.67%{opacity:0}94.17%{opacity:0}100.00%{opacity:1}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><image id="empty" width="1376" height="774" href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAALine truncated
|
||||
|
After Width: | Height: | Size: 1.4 MiB |
|
Before Width: | Height: | Size: 830 KiB |
@@ -0,0 +1 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1600 900" width="1600" height="900" role="img" aria-label="Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects /about and the Inspector opens on it"><style>.c0{transform-origin:0 0;animation:c0 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c0{0.00%{opacity:0;transform:scale(.92)}4.33%{opacity:0;transform:scale(.92)}8.08%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c1{transform-origin:0 0;animation:c1 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c1{0.00%{opacity:0;transform:scale(.92)}4.00%{opacity:0;transform:scale(.92)}7.75%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c2{transform-origin:0 0;animation:c2 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c2{0.00%{opacity:0;transform:scale(.92)}4.67%{opacity:0;transform:scale(.92)}8.42%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c3{transform-origin:0 0;animation:c3 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c3{0.00%{opacity:0;transform:scale(.92)}6.08%{opacity:0;transform:scale(.92)}9.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c4{transform-origin:0 0;animation:c4 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c4{0.00%{opacity:0;transform:scale(.92)}6.41%{opacity:0;transform:scale(.92)}10.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c5{transform-origin:0 0;animation:c5 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c5{0.00%{opacity:0;transform:scale(.92)}6.75%{opacity:0;transform:scale(.92)}10.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c6{transform-origin:0 0;animation:c6 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c6{0.00%{opacity:0;transform:scale(.92)}7.08%{opacity:0;transform:scale(.92)}10.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c7{transform-origin:0 0;animation:c7 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c7{0.00%{opacity:0;transform:scale(.92)}3.66%{opacity:0;transform:scale(.92)}7.41%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c8{transform-origin:0 0;animation:c8 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c8{0.00%{opacity:0;transform:scale(.92)}7.41%{opacity:0;transform:scale(.92)}11.16%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c9{transform-origin:0 0;animation:c9 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c9{0.00%{opacity:0;transform:scale(.92)}7.75%{opacity:0;transform:scale(.92)}11.50%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c10{transform-origin:0 0;animation:c10 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c10{0.00%{opacity:0;transform:scale(.92)}8.08%{opacity:0;transform:scale(.92)}11.83%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.c11{transform-origin:0 0;animation:c11 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes c11{0.00%{opacity:0;transform:scale(.92)}8.42%{opacity:0;transform:scale(.92)}12.17%{opacity:1;transform:scale(1)}100.00%{opacity:1;transform:scale(1)}}.full{animation:full 12s cubic-bezier(.45,0,.25,1) infinite}@keyframes full{0.00%{clip-path:inset(0 0 100% 0)}10.83%{clip-path:inset(0 0 100% 0)}21.67%{clip-path:inset(0 0 0 0)}100.00%{clip-path:inset(0 0 0 0)}}.ptr{opacity:0;animation:ptr 12s cubic-bezier(.4,0,.2,1) infinite}@keyframes ptr{0.00%{opacity:0;transform:translate(978.5px,714.0px)}25.83%{opacity:0;transform:translate(978.5px,714.0px)}27.50%{opacity:1;transform:translate(978.5px,714.0px)}35.83%{opacity:1;transform:translate(718.5px,505.2px)}36.67%{opacity:1;transform:translate(718.5px,505.2px) scale(.82)}37.92%{opacity:1;transform:translate(718.5px,505.2px)}45.83%{opacity:0;transform:translate(718.5px,505.2px)}100.00%{opacity:0;transform:translate(718.5px,505.2px)}}.sel{animation:sel 12s ease-out infinite}@keyframes sel{0.00%{opacity:0}36.67%{opacity:0}39.17%{opacity:1}100.00%{opacity:1}}.insp{animation:insp 12s cubic-bezier(.2,.8,.2,1) infinite}@keyframes insp{0.00%{opacity:0;transform:translateX(48px)}37.08%{opacity:0;transform:translateX(48px)}42.08%{opacity:1;transform:translateX(0)}100.00%{opacity:1;transform:translateX(0)}}.cover{opacity:0;animation:cover 12s linear infinite}@keyframes cover{0.00%{opacity:1}1.67%{opacity:0}94.17%{opacity:0}100.00%{opacity:1}}@media (prefers-reduced-motion: reduce){*{animation:none!important}}</style><defs><image id="empty" width="1376" height="774" href="data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQABAAD/4gHYSUNDX1BST0ZJTEUAAQEAAAHIAAAAAAQwAABtbnRyUkdCIFhZWiAH4AABAAEAAAAAAABhY3NwAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQAA9tYAAQAAAADTLQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAlkZXNjAAAA8AAAACRyWFlaAAABFAAAABRnWFlaAAABKAAAABRiWFlaAAABPAAAABR3dHB0AAABUAAAABRyVFJDAAABZAAAAChnVFJDAAABZAAAAChiVFJDAAABZAAAAChjcHJ0AAABjAAAADxtbHVjAAAAAAAAAAEAAAAMZW5VUwAAAAgAAAAcAHMAUgBHAEJYWVogAAAAAAAAb6IAADj1AAADkFhZWiAALine truncated
|
||||
|
After Width: | Height: | Size: 1.4 MiB |
|
Before Width: | Height: | Size: 642 KiB After Width: | Height: | Size: 640 KiB |
|
Before Width: | Height: | Size: 643 KiB After Width: | Height: | Size: 642 KiB |
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@expo/explore",
|
||||
"version": "0.19.5",
|
||||
"version": "0.19.7",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@expo/explore",
|
||||
"version": "0.19.5",
|
||||
"version": "0.19.7",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@expo/repack-app": "0.10.1",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@expo/explore",
|
||||
"version": "0.19.5",
|
||||
"version": "0.19.7",
|
||||
"description": "Source-driven mobile app maps, deterministic CI capture, and visual reviews",
|
||||
"license": "MIT",
|
||||
"type": "module",
|
||||
|
||||
@@ -0,0 +1,243 @@
|
||||
// The README's two animated SVGs, written by readme-screenshots.mjs. Each is a plain image: CSS keyframes on one loop,
|
||||
// every picture inlined as a JPEG data URI (an SVG shown with <img> loads nothing), and with prefers-reduced-motion
|
||||
// it shows its last frame, which is also what a viewer that does not animate SVG shows.
|
||||
//
|
||||
// readme-hero the Viewer's Map, built from real Viewer frames: the screens appear row by row, the transitions
|
||||
// wipe in from the top, then a click selects a screen and the Inspector slides in
|
||||
// readme-compare one modified screen wiping from its base capture to its head capture, the changed regions pulsing
|
||||
import { ZipReader, Uint8ArrayReader, Uint8ArrayWriter } from "@zip.js/zip.js";
|
||||
|
||||
/** The soft stage the PR comment picture sits on too (stagedComment in readme-screenshots.mjs), and its accents. */
|
||||
const STAGE = {
|
||||
light: { stage: "#F6F8FA", border: "#D1D9E0", shadow: "rgba(17,17,17,0.14)", text: "#1F2328", muted: "#59636E", accent: "#0969DA", region: "#D4520F" },
|
||||
dark: { stage: "#151B23", border: "#3D444D", shadow: "rgba(1,4,9,0.6)", text: "#F0F6FC", muted: "#9198A1", accent: "#4493F8", region: "#F0883E" },
|
||||
};
|
||||
const FONT = "-apple-system, BlinkMacSystemFont, 'Segoe UI', 'Noto Sans', Helvetica, Arial, sans-serif";
|
||||
const MONO = "ui-monospace, SFMono-Regular, 'SF Mono', Menlo, Consolas, monospace";
|
||||
const JPEG_QUALITY = 82;
|
||||
|
||||
const dataUri = jpeg => `data:image/jpeg;base64,${jpeg.toString("base64")}`;
|
||||
const escapeXml = text => text.replace(/&/g, "&").replace(/</g, "<").replace(/>/g, ">").replace(/"/g, """);
|
||||
const box = ({ x, y, width, height }) => `x="${x}" y="${y}" width="${width}" height="${height}"`;
|
||||
|
||||
/** Keyframes given in seconds on a shared loop, so every element stays in step. */
|
||||
function keyframes(name, loop, frames) {
|
||||
return `@keyframes ${name}{${frames.map(([at, css]) => `${((at / loop) * 100).toFixed(2)}%{${css}}`).join("")}}`;
|
||||
}
|
||||
|
||||
/**
|
||||
* Photographs the hero's states from a Viewer page whose Map has its camera set and nothing selected: the Map without
|
||||
* its screens, without its edges, and whole; then it clicks `select`, which opens the Inspector without moving the
|
||||
* camera, and photographs that. Returns the frames and where each screen card, the Inspector and the selected card are.
|
||||
*/
|
||||
export async function captureHeroFrames(page, { select, viewport }) {
|
||||
const shoot = () => page.screenshot({ type: "jpeg", quality: JPEG_QUALITY });
|
||||
const neutral = () => page.mouse.move(viewport.width - 4, viewport.height - 4);
|
||||
const rect = locator => locator.boundingBox().then(b => b && { x: Math.round(b.x), y: Math.round(b.y), width: Math.round(b.width), height: Math.round(b.height) });
|
||||
const camera = () => page.locator(".react-flow__viewport").evaluate(el => el.style.transform);
|
||||
const target = page.locator(`.screen-screenshot-target[title="${select}"]`);
|
||||
|
||||
// A card under the pointer dims the others and highlights its edges; let that fade before the first frame.
|
||||
await neutral();
|
||||
await page.waitForTimeout(1000);
|
||||
const at = await camera();
|
||||
const selected = await rect(target);
|
||||
if (!selected) throw new Error(`The hero needs ${select} on the Map.`);
|
||||
const cards = [];
|
||||
for (const node of await page.locator(".react-flow__node").all()) {
|
||||
const b = await rect(node);
|
||||
if (b && b.x < viewport.width && b.y < viewport.height && b.x + b.width > 0 && b.y + b.height > 0) cards.push(b);
|
||||
}
|
||||
const full = await shoot();
|
||||
const hide = async css => {
|
||||
const style = await page.addStyleTag({ content: `${css} { visibility: hidden !important; }` });
|
||||
await page.waitForTimeout(300);
|
||||
return style;
|
||||
};
|
||||
const edges = await hide(".react-flow__edges, .react-flow__edge, .react-flow__edgelabel-renderer");
|
||||
const screensOnly = await shoot();
|
||||
const nodes = await hide(".react-flow__node");
|
||||
const empty = await shoot();
|
||||
for (const style of [edges, nodes]) await style.evaluate(el => el.remove());
|
||||
|
||||
await target.click();
|
||||
await neutral();
|
||||
await page.waitForTimeout(1500);
|
||||
const inspector = await rect(page.locator("aside.right-panel"));
|
||||
if (!inspector) throw new Error(`Selecting ${select} did not open the Inspector.`);
|
||||
if ((await camera()) !== at) throw new Error(`The Map's camera moved when ${select} was selected: ${at} → ${await camera()}.`);
|
||||
const inspecting = await shoot();
|
||||
return { viewport, empty, screensOnly, full, inspecting, cards, selected, inspector };
|
||||
}
|
||||
|
||||
/**
|
||||
* The hero: the frames from captureHeroFrames as a window on a rounded 1600×900 stage. Each screen
|
||||
* card is a clip of the screens-only frame, so what appears is exactly what the Viewer draws.
|
||||
*/
|
||||
export function heroSvg(frames, theme, alt) {
|
||||
const t = STAGE[theme];
|
||||
const LOOP = 12;
|
||||
const W = 1600, H = 900;
|
||||
const { viewport: v } = frames;
|
||||
const wx = (W - v.width) / 2, wy = (H - v.height) / 2;
|
||||
const css = [];
|
||||
const defs = [];
|
||||
const layers = [];
|
||||
const image = (id, jpeg) => defs.push(`<image id="${id}" width="${v.width}" height="${v.height}" href="${dataUri(jpeg)}"/>`);
|
||||
image("empty", frames.empty);
|
||||
image("screens", frames.screensOnly);
|
||||
image("full", frames.full);
|
||||
image("inspecting", frames.inspecting);
|
||||
|
||||
// Cards appear a row at a time, top to bottom, as the Map lays out taps from launch; a row's cards left to right.
|
||||
const PAD = 18;
|
||||
const rows = [...new Set(frames.cards.map(c => c.y))].sort((a, b) => a - b);
|
||||
frames.cards.forEach((card, i) => {
|
||||
const appear = 0.4 + rows.indexOf(card.y) * 0.35 + (card.x / v.width) * 0.3;
|
||||
const clip = { x: card.x - PAD, y: card.y - PAD, width: card.width + PAD * 2, height: card.height + PAD * 2 };
|
||||
defs.push(`<clipPath id="c${i}"><rect ${box(clip)}/></clipPath>`);
|
||||
css.push(`.c${i}{transform-origin:0 0;animation:c${i} ${LOOP}s cubic-bezier(.2,.8,.2,1) infinite}`);
|
||||
css.push(keyframes(`c${i}`, LOOP, [[0, "opacity:0;transform:scale(.92)"], [appear, "opacity:0;transform:scale(.92)"], [appear + 0.45, "opacity:1;transform:scale(1)"], [LOOP, "opacity:1;transform:scale(1)"]]));
|
||||
// Scaled about the card's centre: the class sits on a group whose origin is there.
|
||||
const cx = card.x + card.width / 2, cy = card.y + card.height / 2;
|
||||
layers.push(`<g transform="translate(${cx} ${cy})"><g class="c${i}"><g transform="translate(${-cx} ${-cy})" clip-path="url(#c${i})"><use href="#screens"/></g></g></g>`);
|
||||
});
|
||||
const settled = 0.4 + (rows.length - 1) * 0.35 + 0.75;
|
||||
|
||||
// The transitions wipe in from the top: the full frame over the cards, which it draws in the same places.
|
||||
const EDGES = settled - 0.2, EDGES_END = EDGES + 1.3;
|
||||
css.push(`.full{animation:full ${LOOP}s cubic-bezier(.45,0,.25,1) infinite}`);
|
||||
css.push(keyframes("full", LOOP, [[0, "clip-path:inset(0 0 100% 0)"], [EDGES, "clip-path:inset(0 0 100% 0)"], [EDGES_END, "clip-path:inset(0 0 0 0)"], [LOOP, "clip-path:inset(0 0 0 0)"]]));
|
||||
layers.push(`<use class="full" href="#full"/>`);
|
||||
|
||||
// A pointer glides to the selected card and clicks; the selection lands and the Inspector slides in.
|
||||
const { selected: s, inspector: p } = frames;
|
||||
const target = { x: s.x + s.width * 0.55, y: s.y + s.height * 0.45 };
|
||||
const start = { x: Math.min(v.width - 120, target.x + 260), y: Math.min(v.height - 60, target.y + 220) };
|
||||
const MOVE = EDGES_END + 0.5, CLICK = MOVE + 1.2;
|
||||
const pointer = (x, y, extra = "") => `transform:translate(${x.toFixed(1)}px,${y.toFixed(1)}px)${extra}`;
|
||||
css.push(`.ptr{opacity:0;animation:ptr ${LOOP}s cubic-bezier(.4,0,.2,1) infinite}`);
|
||||
css.push(keyframes("ptr", LOOP, [
|
||||
[0, `opacity:0;${pointer(start.x, start.y)}`], [MOVE, `opacity:0;${pointer(start.x, start.y)}`], [MOVE + 0.2, `opacity:1;${pointer(start.x, start.y)}`],
|
||||
[CLICK, `opacity:1;${pointer(target.x, target.y)}`], [CLICK + 0.1, `opacity:1;${pointer(target.x, target.y, " scale(.82)")}`],
|
||||
[CLICK + 0.25, `opacity:1;${pointer(target.x, target.y)}`], [CLICK + 1.2, `opacity:0;${pointer(target.x, target.y)}`], [LOOP, `opacity:0;${pointer(target.x, target.y)}`],
|
||||
]));
|
||||
defs.push(`<clipPath id="canvas"><rect x="0" y="0" width="${p.x}" height="${v.height}"/></clipPath>`);
|
||||
defs.push(`<clipPath id="panel"><rect ${box(p)}/></clipPath>`);
|
||||
css.push(`.sel{animation:sel ${LOOP}s ease-out infinite}`);
|
||||
css.push(keyframes("sel", LOOP, [[0, "opacity:0"], [CLICK + 0.1, "opacity:0"], [CLICK + 0.4, "opacity:1"], [LOOP, "opacity:1"]]));
|
||||
css.push(`.insp{animation:insp ${LOOP}s cubic-bezier(.2,.8,.2,1) infinite}`);
|
||||
css.push(keyframes("insp", LOOP, [[0, "opacity:0;transform:translateX(48px)"], [CLICK + 0.15, "opacity:0;transform:translateX(48px)"], [CLICK + 0.75, "opacity:1;transform:translateX(0)"], [LOOP, "opacity:1;transform:translateX(0)"]]));
|
||||
layers.push(`<use class="sel" href="#inspecting" clip-path="url(#canvas)"/>`);
|
||||
layers.push(`<g class="insp"><use href="#inspecting" clip-path="url(#panel)"/></g>`);
|
||||
layers.push(`<g class="ptr"><path d="M0 0L0 22L6 16.5L10.5 26L14 24.5L9.8 15.2L18 15.2Z" fill="#111" stroke="#fff" stroke-width="1.6" stroke-linejoin="round"/></g>`);
|
||||
|
||||
// The empty Map covers the reset: it fades in over the last frame, and the loop starts again beneath it.
|
||||
css.push(`.cover{opacity:0;animation:cover ${LOOP}s linear infinite}`);
|
||||
css.push(keyframes("cover", LOOP, [[0, "opacity:1"], [0.2, "opacity:0"], [LOOP - 0.7, "opacity:0"], [LOOP, "opacity:1"]]));
|
||||
layers.push(`<use class="cover" href="#empty"/>`);
|
||||
|
||||
css.push("@media (prefers-reduced-motion: reduce){*{animation:none!important}}");
|
||||
defs.push(`<clipPath id="window"><rect width="${v.width}" height="${v.height}" rx="14"/></clipPath>`);
|
||||
defs.push(`<filter id="shadow" x="-10%" y="-10%" width="120%" height="125%"><feDropShadow dx="0" dy="2" stdDeviation="2" flood-color="${t.shadow}" flood-opacity=".3"/><feDropShadow dx="0" dy="30" stdDeviation="35" flood-color="${t.shadow}"/></filter>`);
|
||||
defs.push(`<clipPath id="stage"><rect width="${W}" height="${H}" rx="22"/></clipPath>`);
|
||||
return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${W} ${H}" width="${W}" height="${H}" role="img" aria-label="${escapeXml(alt)}">`
|
||||
+ `<style>${css.join("")}</style><defs>${defs.join("")}</defs>`
|
||||
+ `<g clip-path="url(#stage)"><rect width="${W}" height="${H}" fill="${t.stage}"/>`
|
||||
+ `<rect x="${wx}" y="${wy}" width="${v.width}" height="${v.height}" rx="14" fill="${t.stage}" filter="url(#shadow)"/>`
|
||||
+ `<g transform="translate(${wx} ${wy})"><g clip-path="url(#window)"><use href="#empty"/>${layers.join("")}</g>`
|
||||
+ `<rect x=".5" y=".5" width="${v.width - 1}" height="${v.height - 1}" rx="14" fill="none" stroke="${t.border}"/></g></g></svg>`;
|
||||
}
|
||||
|
||||
/** review.json and an asset reader from a sealed review report's bytes. */
|
||||
export async function openReport(bytes) {
|
||||
const reader = new ZipReader(new Uint8ArrayReader(new Uint8Array(bytes)));
|
||||
const entries = new Map((await reader.getEntries()).map(entry => [entry.filename, entry]));
|
||||
const read = async name => {
|
||||
const entry = entries.get(name);
|
||||
if (!entry) throw new Error(`The report has no ${name}.`);
|
||||
return Buffer.from(await entry.getData(new Uint8ArrayWriter()));
|
||||
};
|
||||
const review = JSON.parse((await read("review.json")).toString("utf8")).review;
|
||||
return { review, asset: sha => read(`assets/${sha}.png`) };
|
||||
}
|
||||
|
||||
/** A PNG as a JPEG at most `maxHeight` tall, drawn by the browser so the script needs no image library. */
|
||||
async function toJpeg(browser, png, maxHeight) {
|
||||
const page = await browser.newPage();
|
||||
try {
|
||||
const base64 = await page.evaluate(async ({ png, maxHeight, quality }) => {
|
||||
const bitmap = await createImageBitmap(await (await fetch(`data:image/png;base64,${png}`)).blob());
|
||||
const scale = Math.min(1, maxHeight / bitmap.height);
|
||||
const canvas = document.createElement("canvas");
|
||||
canvas.width = Math.round(bitmap.width * scale);
|
||||
canvas.height = Math.round(bitmap.height * scale);
|
||||
const context = canvas.getContext("2d");
|
||||
context.imageSmoothingQuality = "high";
|
||||
context.drawImage(bitmap, 0, 0, canvas.width, canvas.height);
|
||||
return canvas.toDataURL("image/jpeg", quality).split(",")[1];
|
||||
}, { png: png.toString("base64"), maxHeight, quality: JPEG_QUALITY / 100 });
|
||||
return Buffer.from(base64, "base64");
|
||||
} finally {
|
||||
await page.close();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* The surface of the Compare key `key` (the slug of the Viewer's #/compare/<key>, which is the route without its
|
||||
* slash) in `theme`, among the report's visually modified screens.
|
||||
*/
|
||||
export function compareSurface(review, key, theme) {
|
||||
const route = `/${key}`;
|
||||
const surface = review.surfaces.find(s => (s.head ?? s.base)?.route === route && s.colorScheme === theme && s.visual?.verdict === "modified");
|
||||
if (!surface) throw new Error(`No visually modified ${route} in ${theme} in this report; pass --compare <key> from a #/compare/<key> URL.`);
|
||||
return surface;
|
||||
}
|
||||
|
||||
/** The Compare picture: `surface`'s base capture wiping to its head capture, its changed regions outlined. */
|
||||
export async function compareSvg(browser, report, surface, theme, alt) {
|
||||
const t = STAGE[theme];
|
||||
const LOOP = 7;
|
||||
const W = 1000, H = 600;
|
||||
const { baseImage, headImage } = surface;
|
||||
const PH = 540, PW = Math.round(PH * headImage.width / headImage.height);
|
||||
const x = (W - PW) / 2, y = (H - PH) / 2;
|
||||
const k = PW / headImage.width;
|
||||
const before = dataUri(await toJpeg(browser, await report.asset(baseImage.sha256), PH * 2));
|
||||
const after = dataUri(await toJpeg(browser, await report.asset(headImage.sha256), PH * 2));
|
||||
const { pullRequest } = report.review;
|
||||
const css = [];
|
||||
// The After capture is revealed left to right, and the divider rides the edge of the reveal.
|
||||
css.push(`.after{animation:wipe ${LOOP}s cubic-bezier(.65,0,.35,1) infinite}`);
|
||||
css.push(keyframes("wipe", LOOP, [[0, "clip-path:inset(0 100% 0 0)"], [1.0, "clip-path:inset(0 100% 0 0)"], [2.6, "clip-path:inset(0 0 0 0)"], [5.8, "clip-path:inset(0 0 0 0)"], [6.8, "clip-path:inset(0 100% 0 0)"], [LOOP, "clip-path:inset(0 100% 0 0)"]]));
|
||||
css.push(`.divider{opacity:0;animation:divider ${LOOP}s cubic-bezier(.65,0,.35,1) infinite}`);
|
||||
css.push(keyframes("divider", LOOP, [[0, "transform:translateX(0);opacity:0"], [0.8, "transform:translateX(0);opacity:1"], [1.0, "transform:translateX(0);opacity:1"], [2.6, `transform:translateX(${PW}px);opacity:1`], [2.9, `transform:translateX(${PW}px);opacity:0`], [5.8, `transform:translateX(${PW}px);opacity:0`], [6.0, `transform:translateX(${PW}px);opacity:1`], [6.8, "transform:translateX(0);opacity:1"], [LOOP, "transform:translateX(0);opacity:0"]]));
|
||||
css.push(`.regions{animation:regions ${LOOP}s ease-in-out infinite}`);
|
||||
css.push(keyframes("regions", LOOP, [[0, "opacity:0"], [2.7, "opacity:0"], [3.1, "opacity:1"], [3.6, "opacity:.3"], [4.1, "opacity:1"], [5.7, "opacity:1"], [6.0, "opacity:0"], [LOOP, "opacity:0"]]));
|
||||
css.push(`.before-label{opacity:.3;animation:before-label ${LOOP}s linear infinite}.after-label{animation:after-label ${LOOP}s linear infinite}`);
|
||||
css.push(keyframes("before-label", LOOP, [[0, "opacity:1"], [1.8, "opacity:1"], [2.0, "opacity:.3"], [6.2, "opacity:.3"], [6.4, "opacity:1"], [LOOP, "opacity:1"]]));
|
||||
css.push(keyframes("after-label", LOOP, [[0, "opacity:.3"], [1.8, "opacity:.3"], [2.0, "opacity:1"], [6.2, "opacity:1"], [6.4, "opacity:.3"], [LOOP, "opacity:.3"]]));
|
||||
css.push("@media (prefers-reduced-motion: reduce){*{animation:none!important}}");
|
||||
const regions = surface.visual.regions.map(({ rect: r }) =>
|
||||
`<rect x="${(x + r.x * k - 3).toFixed(1)}" y="${(y + r.y * k - 3).toFixed(1)}" width="${(r.width * k + 6).toFixed(1)}" height="${(r.height * k + 6).toFixed(1)}" rx="3" fill="none" stroke="${t.region}" stroke-width="2"/>`).join("");
|
||||
const label = (cls, anchor, lx, title, sub, note) => `<g class="${cls}" font-family="${FONT}" text-anchor="${anchor}">`
|
||||
+ `<text x="${lx}" y="${y + PH / 2 - 14}" font-size="26" font-weight="700" fill="${t.text}">${title}</text>`
|
||||
+ `<text x="${lx}" y="${y + PH / 2 + 12}" font-family="${MONO}" font-size="13" fill="${t.muted}">${escapeXml(sub)}</text>`
|
||||
+ (note ? `<text x="${lx}" y="${y + PH / 2 + 36}" font-size="13" font-weight="600" fill="${t.region}">${note}</text>` : "") + "</g>";
|
||||
const count = surface.visual.regions.length;
|
||||
return `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 ${W} ${H}" width="${W}" height="${H}" role="img" aria-label="${escapeXml(alt)}">`
|
||||
+ `<style>${css.join("")}</style>`
|
||||
+ `<defs><clipPath id="stage"><rect width="${W}" height="${H}" rx="16"/></clipPath><clipPath id="phone"><rect x="${x}" y="${y}" width="${PW}" height="${PH}" rx="40"/></clipPath>`
|
||||
+ `<filter id="shadow" x="-20%" y="-20%" width="140%" height="140%"><feDropShadow dx="0" dy="8" stdDeviation="14" flood-color="${t.shadow}"/></filter></defs>`
|
||||
+ `<g clip-path="url(#stage)"><rect width="${W}" height="${H}" fill="${t.stage}"/>`
|
||||
+ `<rect x="${x}" y="${y}" width="${PW}" height="${PH}" rx="40" fill="${t.stage}" filter="url(#shadow)"/>`
|
||||
+ `<g clip-path="url(#phone)"><image href="${before}" x="${x}" y="${y}" width="${PW}" height="${PH}"/>`
|
||||
+ `<image class="after" href="${after}" x="${x}" y="${y}" width="${PW}" height="${PH}"/></g>`
|
||||
+ `<rect x="${x}" y="${y}" width="${PW}" height="${PH}" rx="40" fill="none" stroke="${t.border}"/>`
|
||||
+ `<g class="divider"><rect x="${x - 1.5}" y="${y}" width="3" height="${PH}" fill="${t.accent}"/><circle cx="${x}" cy="${y + PH / 2}" r="13" fill="${t.accent}"/>`
|
||||
+ `<path d="M${x - 5} ${y + PH / 2 - 4}l-3 4l3 4M${x + 5} ${y + PH / 2 - 4}l3 4l-3 4" stroke="#fff" stroke-width="1.8" fill="none" stroke-linecap="round" stroke-linejoin="round"/></g>`
|
||||
+ `<g class="regions">${regions}</g>`
|
||||
+ label("before-label", "end", x - 44, "Before", `${pullRequest.base.ref} ·${pullRequest.base.sha.slice(0, 7)}`)
|
||||
+ label("after-label", "start", x + PW + 44, "After", `PR #${pullRequest.number} · ${pullRequest.head.sha.slice(0, 7)}`, `${count} changed region${count === 1 ? "" : "s"}`)
|
||||
+ "</g></svg>";
|
||||
}
|
||||
@@ -1,4 +1,4 @@
|
||||
// Regenerates the Viewer screenshots in docs/screenshots from a review report, in light and dark
|
||||
// Regenerates the README's pictures in docs/screenshots from a review report, in light and dark
|
||||
// (the README shows them with <picture>; GitHub Mobile ignores the dark source and shows light). The reference app is euxy
|
||||
// (github.com/brentvatne/euxy): skills/readme-refresh/SKILL.md says which report to pass and how.
|
||||
//
|
||||
@@ -7,8 +7,10 @@
|
||||
//
|
||||
// --report a sealed review report (the hosted link's report.zip?platform=ios, or the PR's zip artifact)
|
||||
// --select the route selected on the hero Map (opens the Inspector); default /settings. The hero zooms in around it
|
||||
// (--zoom, default 73%) and is framed as a window on a soft stage, like the PR comment
|
||||
// --compare the Compare key of a modified screen: the slug in the Viewer's #/compare/<key> URL; default patterns
|
||||
// (--zoom, default 73%) and is an animated SVG of a window on a soft stage (readme-animations.mjs): the
|
||||
// Map's cards appear, its transitions wipe in, and a click on this screen opens the Inspector
|
||||
// --compare the Compare key of a modified screen: the slug in the Viewer's #/compare/<key> URL; default patterns.
|
||||
// It becomes readme-compare-*.svg, its before capture wiping to its after capture
|
||||
// --pr a GitHub PR URL whose Explore comment becomes readme-pr-comment-light.png (public repository): the comment
|
||||
// at its own size on a soft stage, cut off with a fade after the list of changed screens
|
||||
import { chromium } from "@playwright/test";
|
||||
@@ -16,6 +18,7 @@ import { readFile, writeFile } from "node:fs/promises";
|
||||
import { parseArgs } from "node:util";
|
||||
import { fileURLToPath } from "node:url";
|
||||
import { startReportViewer } from "../test/ci/lib/report-viewer.mjs";
|
||||
import { captureHeroFrames, compareSurface, compareSvg, heroSvg, openReport } from "./readme-animations.mjs";
|
||||
|
||||
const { values: args } = parseArgs({
|
||||
options: {
|
||||
@@ -33,15 +36,22 @@ if (!args.report) {
|
||||
|
||||
const out = fileURLToPath(new URL("../docs/screenshots/", import.meta.url));
|
||||
const SHOTS = [
|
||||
{ file: "readme-hero", hash: "#/map", viewport: { width: 1376, height: 774 }, click: "Fit canvas", select: args.select, zoom: Number(args.zoom), framed: true },
|
||||
{ file: "readme-compare", hash: `#/compare/${args.compare}`, viewport: { width: 1760, height: 1000 } },
|
||||
{ file: "readme-hero", hash: "#/map", viewport: { width: 1376, height: 774 }, click: "Fit canvas", select: args.select, zoom: Number(args.zoom), animated: true },
|
||||
{ file: "readme-screens", hash: "#/screens", viewport: { width: 1760, height: 1000 } },
|
||||
];
|
||||
|
||||
const bytes = await readFile(args.report);
|
||||
const report = await openReport(bytes);
|
||||
const { server, url } = await startReportViewer({ bytes, watch: false });
|
||||
const browser = await chromium.launch();
|
||||
try {
|
||||
for (const theme of ["light", "dark"]) {
|
||||
const surface = compareSurface(report.review, args.compare, theme);
|
||||
const path = `${out}readme-compare-${theme}.svg`;
|
||||
await writeFile(path, await compareSvg(browser, report, surface, theme,
|
||||
`The ${surface.head.route} screen of euxy wiping from its capture before the pull request to its capture after it, with the changed regions outlined`));
|
||||
console.log(path);
|
||||
}
|
||||
for (const theme of ["light", "dark"]) for (const shot of SHOTS) {
|
||||
const context = await browser.newContext({ viewport: shot.viewport, deviceScaleFactor: 2, colorScheme: theme });
|
||||
await context.addInitScript(value => localStorage.setItem("expo-explore:theme", value), theme);
|
||||
@@ -54,8 +64,8 @@ try {
|
||||
await page.mouse.move(400, shot.viewport.height - 30);
|
||||
await page.waitForTimeout(1500);
|
||||
}
|
||||
if (shot.select) {
|
||||
// Selecting a screen opens the Inspector without moving the fitted camera.
|
||||
if (shot.select && !shot.animated) {
|
||||
// Selecting a screen opens the Inspector without moving the fitted camera. The animated hero selects it last.
|
||||
await page.locator(`.screen-screenshot-target[title="${shot.select}"]`).click();
|
||||
await page.mouse.move(400, shot.viewport.height - 30);
|
||||
await page.waitForTimeout(1500);
|
||||
@@ -76,12 +86,12 @@ try {
|
||||
await page.mouse.move(shot.viewport.width - 60, shot.viewport.height / 2);
|
||||
await page.waitForTimeout(1200);
|
||||
}
|
||||
if (shot.hash.startsWith("#/compare/") && !page.url().includes(shot.hash)) {
|
||||
throw new Error(`Compare key ${args.compare} is not a screen of this report (the Viewer went to ${page.url()}); pass --compare <key> from a #/compare/<key> URL.`);
|
||||
}
|
||||
const path = `${out}${shot.file}-${theme}.png`;
|
||||
if (shot.framed) await writeFile(path, await stagedWindow(browser, await page.screenshot(), shot.viewport, theme));
|
||||
else await page.screenshot({ path });
|
||||
const path = `${out}${shot.file}-${theme}.${shot.animated ? "svg" : "png"}`;
|
||||
if (shot.animated) {
|
||||
const frames = await captureHeroFrames(page, { select: shot.select, viewport: shot.viewport });
|
||||
await writeFile(path, heroSvg(frames, theme,
|
||||
`Explore's Map of a euxy pull request: the screen cards appear row by row, the transitions between them wipe in, then a click selects ${shot.select} and the Inspector opens on it`));
|
||||
} else await page.screenshot({ path });
|
||||
console.log(path);
|
||||
await context.close();
|
||||
}
|
||||
@@ -114,26 +124,6 @@ try {
|
||||
await server.close?.();
|
||||
}
|
||||
|
||||
/**
|
||||
* A Viewer screenshot as a window on a rounded 1600×900 stage (drawn at 2x), with a hairline border and a soft shadow,
|
||||
* as the post about Explore frames it. The corners outside the stage stay transparent, so it sits on either GitHub theme.
|
||||
*/
|
||||
async function stagedWindow(browser, shot, viewport, theme) {
|
||||
const dark = theme === "dark";
|
||||
const stage = dark ? "#151B23" : "#F6F8FA";
|
||||
const border = dark ? "#3D444D" : "#D1D9E0";
|
||||
const shadow = dark ? "0 2px 4px rgba(1,4,9,0.4), 0 30px 70px rgba(1,4,9,0.6)" : "0 2px 4px rgba(17,17,17,0.04), 0 30px 70px rgba(17,17,17,0.14)";
|
||||
const context = await browser.newContext({ viewport: { width: 1600, height: 900 }, deviceScaleFactor: 2 });
|
||||
const page = await context.newPage();
|
||||
await page.setContent(`<!doctype html><html><body style="margin:0;background:transparent">
|
||||
<div id="stage" style="position:relative;width:1600px;height:900px;background:${stage};border-radius:22px;overflow:hidden">
|
||||
<img src="data:image/png;base64,${shot.toString("base64")}" style="position:absolute;left:${(1600 - viewport.width) / 2}px;top:${(900 - viewport.height) / 2}px;width:${viewport.width}px;height:${viewport.height}px;box-sizing:border-box;border:1px solid ${border};border-radius:14px;box-shadow:${shadow}">
|
||||
</div></body></html>`);
|
||||
const png = await page.locator("#stage").screenshot({ omitBackground: true });
|
||||
await context.close();
|
||||
return png;
|
||||
}
|
||||
|
||||
/**
|
||||
* The comment on a rounded stage as wide as the README column (880 px, drawn at 2x), with a soft shadow and a fade at
|
||||
* the cut. The corners outside the stage stay transparent, so the image sits on either GitHub theme.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
name: readme-refresh
|
||||
description: Refresh Expo Explore's README.md with euxy (github.com/brentvatne/euxy) as the reference app. Regenerate every screenshot in docs/screenshots from a current euxy review report and PR comment, then re-read the README as a first-time user: the top level only says what Explore does, links the live euxy example, gives one quick-start prompt to copy that reviews a change to your own app or explores a build you point it to, and one for setting up CI; everything else lives in collapsibles. Use after a Viewer or PR-comment change that the README shows, a new command or setting, or a release that made a README claim stale. Not for the docs/ guides or the shipped skills.
|
||||
description: Refresh Expo Explore's README.md with euxy (github.com/brentvatne/euxy) as the reference app. Regenerate every screenshot and animated SVG in docs/screenshots from a current euxy review report and PR comment, then re-read the README as a first-time user: the top level only says what Explore does, links the live euxy example, gives one quick-start prompt to copy that reviews a change to your own app or explores a build you point it to, and one for setting up CI; everything else lives in collapsibles. Use after a Viewer or PR-comment change that the README shows, a new command or setting, or a release that made a README claim stale. Not for the docs/ guides or the shipped skills.
|
||||
---
|
||||
|
||||
# Refresh the README
|
||||
@@ -24,17 +24,25 @@ scripts/refresh-viewer-preview-fixtures.sh '<hosted link>' brentvatne/euxy#<n>
|
||||
|
||||
Do not pick a same-tree demo PR, where every change is noise. The refreshed fixtures reach the live example on the next push to main, or when you run **Example report** from GitHub Actions. `curl -s "<hosted link>/api/v1/screens?status=added,removed,modified&platform=ios"` lists what changed, which tells you which screen to select and compare.
|
||||
|
||||
## 2. Regenerate every screenshot
|
||||
## 2. Regenerate every screenshot and animation
|
||||
|
||||
```sh
|
||||
npm ci
|
||||
node scripts/readme-screenshots.mjs --report ~/euxy-report/ios.zip --select /settings --compare patterns --pr https://github.com/brentvatne/euxy/pull/<n>
|
||||
node scripts/readme-screenshots.mjs --report ~/euxy-report/ios.zip --select /about --compare patterns --pr https://github.com/brentvatne/euxy/pull/<n>
|
||||
```
|
||||
|
||||
- `--select` is the route selected on the hero Map (the Inspector opens on it): choose an added or clearly modified screen.
|
||||
- `--compare` is the key in the Viewer's `#/compare/<key>` URL for a **modified** screen with outlined regions (open the report, click the screen in Compare, copy the key). The script fails if the key is not in the report.
|
||||
- `--select` is the route the hero's pointer clicks on the Map (the Inspector opens on it): choose an added or clearly modified screen. The script zooms in around it, so it must be a screen the Map shows.
|
||||
- `--compare` is the key in the Viewer's `#/compare/<key>` URL for a **modified** screen with outlined regions (open the report, click the screen in Compare, copy the key): the route without its slash. The script fails if the report has no visually modified screen at that route.
|
||||
- `--pr` screenshots the Explore comment on that PR: the fixtures' `source`. Headless Chromium needs a colour emoji font for the result glyphs (`sudo apt-get install fonts-noto-color-emoji` on Debian/Ubuntu); a comment with hollow boxes where 🟩 should be is not acceptable.
|
||||
- The script serves the report through the Viewer's Vite dev server, so no build is needed. It writes a `-light` and a `-dark` PNG for every shot (the PR comment too: signed-out github.com follows `prefers-color-scheme`). The README shows each pair with `<picture>`: a `<source media="(prefers-color-scheme: dark)">` for the dark file and an `<img>` with the alt text and the light file, which is what GitHub Mobile shows (it ignores the dark source), so the light file is the one that must always be right.
|
||||
- The script serves the report through the Viewer's Vite dev server, so no build is needed. It writes a `-light` and a `-dark` file for every picture (the PR comment too: signed-out github.com follows `prefers-color-scheme`). The README shows each pair with `<picture>`: a `<source media="(prefers-color-scheme: dark)">` for the dark file and an `<img>` with the alt text and the light file, which is what GitHub Mobile shows (it ignores the dark source), so the light file is the one that must always be right.
|
||||
|
||||
Two of the pictures are animated SVGs, built by `scripts/readme-animations.mjs` in the same run; there is nothing else to run when the screenshots change:
|
||||
|
||||
- `readme-hero-*.svg` is made of real Viewer frames at the zoomed Map camera: the Map without screens, the screens without edges, the whole Map, and the Map after the pointer clicks `--select`. The cards appear row by row, the edges wipe in from the top, then the pointer clicks and the Inspector slides in. Each is about 1.4 MB: four 2x JPEG frames inlined, since an SVG shown with `<img>` can load nothing. Anything the Viewer draws on the Map or in the Inspector shows up here on the next run, so regenerate it after a Viewer change the hero shows.
|
||||
- `readme-compare-*.svg` is the `--compare` screen's base capture wiping to its head capture, with the report's changed regions pulsing. It is drawn from `review.json` and the report's assets, not from a Viewer screenshot, so a Viewer change does not stale it, but a new report does.
|
||||
- Both loop on CSS keyframes, and with `prefers-reduced-motion` they hold the last frame: Inspector open, regions outlined. That frame is also what a viewer that does not animate SVG shows, so it must read on its own.
|
||||
|
||||
Open each SVG in a browser before committing, light and dark, and watch a full loop: every card should appear once and land where the whole Map has it, with no hover highlight in the frames before the click; the pointer should click the `--select` card; the Inspector should open on that screen; Compare's outlines should sit on the changed text, not beside it. To look at one moment, pause the animations in the console: `document.getAnimations().forEach(a => { a.pause(); a.currentTime = 5000; })`. Keep the README's `<img>` and `<source>` pointing at the `.svg` files.
|
||||
|
||||
`docs/screenshots/readme-exploration-light.png` is the black-box map and comes from a euxy `explore:binary` run (`npx @expo/explore explore:binary <euxy simulator build> --no-upload`, then `expo-explore view --dir <output>` at 1760×1000, Map, Fit canvas). It has no dark variant and is a plain Markdown image. Regenerate it when the Map's rendering of edges or labels changed; otherwise keep it, and say so in the PR.
|
||||
|
||||
@@ -53,18 +61,18 @@ cd - && npm run build:cli && node scripts/readme-reports-rows.mjs > /tmp/reports
|
||||
- The script renders the picker as the CLI draws it (96 columns, the newest run selected) and writes the terminal body as HTML: each coloured piece is exactly its characters wide, so columns line up, and the wordmark is drawn as cell rectangles, since a design tool's font does not draw `█▀▄` cell for cell.
|
||||
- In Paper, replace the frame named "Terminal" inside each artboard's window with that HTML, check both artboards in a screenshot (crisp wordmark, aligned columns, the selected row highlighted to the end, coloured counts), and export both at 2x as `readme-reports-light.png` and `readme-reports-dark.png`. The window's title bar reads `npx @expo/explore reports`, as people run it.
|
||||
|
||||
Look at every PNG you produced before committing, light and dark: the selected screen should be the one you asked for, the Compare view must show Before and After with outlines, the Screens grid must show the added, removed and modified status dots, the PR comment must show the heading links and result glyphs. Describe each in its Markdown alt text as what the picture shows, not what the feature is.
|
||||
Look at every PNG you produced before committing, light and dark: the Screens grid must show the added, removed and modified status dots, the PR comment must show the heading links and result glyphs. Describe each in its Markdown alt text as what the picture shows, not what the feature is.
|
||||
|
||||
## 3. Pass over the content as a first-time user
|
||||
|
||||
Read the README top to bottom once without opening a collapsible. At that level it may only answer, in this order:
|
||||
|
||||
1. What Explore is (one short paragraph), the hero image, and the link to the live euxy example (`explore-example--euxy.expo.app`, redeployed on every merge to main by `.github/workflows/example-report.yml`). Under it, one table row of three pictures with a one-line caption each: Compare, Screens, and the PR comment (which says it needs CI), then the agent prompt collapsed as **Ask an agent about a report**. The hero is a zoomed Map framed as a window on a stage (`stagedWindow` in the script); the three below are plain.
|
||||
2. **Quick start**: one path. A single prompt to paste into Claude Code or Codex that reviews a change to the reader's own Expo app through the explore-setup skill's "Review a change on this machine" section, or, when they point it to a build (or the app is not an Expo project), explores a simulator build through the explore-binary skill. Then one sentence on what each case needs (a review needs an Expo account, is built on EAS, and is captured on EAS Simulator or a local simulator; exploring a build needs a Claude Code or Codex login and EAS Simulator or a local simulator, and no Expo account locally). Then one **Run it yourself** collapsible with both by hand: the numbered steps for a review, with nothing optional in them (make the app buildable on EAS: login, init, bundle identifier, a simulator profile named `explore`, and commit, since the before build is the last commit; then edit a screen near its top and run `capture`, or `capture --simulator local`), and the `explore:binary` commands, including `--simulator local`. Then the `reports` picker image (`readme-reports-*.png`) with one sentence on saved runs, at the top level, and one collapsible for other commits (`--committed`, `--base`/`--head`) and what a review does on the machine. Run the steps on a fresh `create-expo-app` before changing them.
|
||||
1. What Explore is (one short paragraph), the hero image, and the link to the live euxy example (`explore-example--euxy.expo.app`, redeployed on every merge to main by `.github/workflows/example-report.yml`). Under it, Compare at full width with a one-line caption, then one table row of two pictures with a one-line caption each: Screens and the PR comment (which says it needs CI), then the agent prompt collapsed as **Ask an agent about a report**. The hero is the animated zoomed Map, framed as a window on a stage, and Compare is the animated wipe (both from `readme-animations.mjs`); the Screens and PR comment pictures are PNGs. Compare gets its own row because a phone wiping from before to after is unreadable at a third of the column.
|
||||
2. **Quick start**: one path. A single prompt to paste into Claude Code or Codex that reviews a change to the reader's own Expo app through the explore-setup skill's "Review a change on this machine" section, or, when they point it to a build (or the app is not an Expo project), explores a simulator build through the explore-binary skill. Then one sentence on what each case needs (a review needs an Expo account, is built on EAS, and is captured on EAS Simulator or a local simulator; exploring a build needs a Claude Code or Codex login and EAS Simulator or a local simulator, and no Expo account locally), and under it one `> [!NOTE]` alert: EAS Simulator is in preview, with the waitlist link and `--simulator local` as the alternative. Then one **Run it yourself** collapsible with both by hand: the numbered steps for a review, with nothing optional in them (make the app buildable on EAS: login, init, bundle identifier, a simulator profile named `explore`, and commit, since the before build is the last commit; then edit a screen near its top and run `capture`, or `capture --simulator local`), and the `explore:binary` commands, including `--simulator local`. Right after **Run it yourself**, one `> [!WARNING]` alert: a review runs both commits' code on the reader's machine, so review only commits they would run. These are the README's only two alerts; do not add more, or they stop standing out. Then the `reports` picker image (`readme-reports-*.png`) with one sentence on saved runs, at the top level, and one collapsible for other commits (`--committed`, `--base`/`--head`) and what a review does on the machine. Run the steps on a fresh `create-expo-app` before changing them.
|
||||
3. **Map every screen of any app**: one sentence on what exploring a build shows (pointing back to the quick start, which runs it), then its collapsibles: its options, exploring a session already started, and what a run without source shows.
|
||||
4. **Set up CI**: one sentence, then two subsections, each a sentence on what it gives and a prompt to paste: **Review on every PR** (the setup prompt, then a few grouped collapsibles: Hosted previews first, then Manual setup (the setup prompt's steps done by hand, in order: setup, doctor, secrets, baseline, first PR), Capture modes: deterministic or agent, iOS, Android, or both, Keep your setup current) and **Compare any two commits** (a prompt that follows the explore-setup skill's "Compare any two commits" section, the ways to snapshot a release as bullets, then the comparison workflow collapsed).
|
||||
|
||||
Lead with prompts, not explanations: a reader should be able to copy something and see Explore work. Everything else, the manual commands, requirements, options, the manual setup, capture modes, hosted previews, iOS and Android, agent mode, repository settings, how agents read a report, how it works, limitations, contributing, goes into a `<details>` block under the section it belongs to, with a `<summary>` that says what the reader will find. Keep bullets to one or two sentences. Group related collapsibles rather than adding one per topic, so a section shows a handful, not nine. Requirements sit collapsed right under the example report link. Keep the collapsibles' `id` attributes that other docs link to (`#hosted-previews`, `#platforms`, `#compare`, `#agents`); the Terms and How agents read a report collapsibles live under Additional information, and keep the Inspiration section (screenmap and Revyl's Atlas).
|
||||
Lead with prompts, not explanations: a reader should be able to copy something and see Explore work. Everything else, the manual commands, requirements, options, the manual setup, capture modes, hosted previews, iOS and Android, agent mode, repository settings, how agents read a report, how it works, limitations, contributing, goes into a `<details>` block under the section it belongs to, with a `<summary>` that says what the reader will find. Keep bullets to one or two sentences. Group related collapsibles rather than adding one per topic, so a section shows a handful, not nine. Requirements sit collapsed right under the example report link. The **How it works** collapsible opens with a Mermaid `sequenceDiagram` of a PR review (pull request, GitHub Actions, EAS Build, EAS Simulator), followed by the facts it cannot show as bullets: who triggers a review, what Modified means, session retries. Check its steps against `CI-FLOW.md` and the `ci:*` commands, and edit the diagram's text, not a picture: GitHub draws it. Keep the collapsibles' `id` attributes that other docs link to (`#hosted-previews`, `#platforms`, `#compare`, `#agents`); the Terms and How agents read a report collapsibles live under Additional information, and keep the Inspiration section (screenmap and Revyl's Atlas).
|
||||
|
||||
Check that each prompt still works as written:
|
||||
- the skill links it names (`https://unpkg.com/@expo/explore/skills/...`) are files the package ships (`files` in `package.json`), and they open from the published release;
|
||||
|
||||
@@ -150,7 +150,8 @@ async function prepareCiRun(options: Pick<PublicCiOptions, "baseProject" | "head
|
||||
links: viewerLinks({ repository: presentation.repository, headSha: presentation.head.sha, runId: environment.GITHUB_RUN_ID!,
|
||||
runAttempt: environment.GITHUB_RUN_ATTEMPT!, configPath: repositoryConfigPath }),
|
||||
startedAt: now(), updatedAt: now(), build: { platform: config.app.platform, easProfile: config.app.easProfile }, artifactOnly: true,
|
||||
...(config.target ? { target: config.target } : {}), ...(options.targets && options.targets.length > 1 ? { targets: options.targets } : {}) };
|
||||
...(config.target ? { target: config.target } : {}), ...(options.targets && options.targets.length > 1 ? { targets: options.targets } : {}),
|
||||
...(config.report?.comment?.map ? { map: true } : {}) };
|
||||
return { projects, output, state };
|
||||
}
|
||||
|
||||
|
||||
@@ -104,7 +104,9 @@ export type ExploreConfig = {
|
||||
setup?: ExploreSetupAction[];
|
||||
agent?: { provider: "openai" | "anthropic"; model: string; instructions?: string };
|
||||
/** Hosted previews: one token-gated EAS Hosting deployment per review, see docs/private-review.md. */
|
||||
report?: { preview?: { hosting: "eas"; /** null: the link never expires; the deployment lives until someone deletes it. */ expiresAfterDays: number | null; owner?: string; project?: string } };
|
||||
report?: { preview?: { hosting: "eas"; /** null: the link never expires; the deployment lives until someone deletes it. */ expiresAfterDays: number | null; owner?: string; project?: string };
|
||||
/** `map`: the PR comment draws a Mermaid map of the changed screens and the screens that lead to them. Off by default. */
|
||||
comment?: { map: boolean } };
|
||||
/**
|
||||
* `trustedAuthors`: GitHub logins (e.g. `devin-ai-integration[bot]`) whose same-repository pull
|
||||
* requests the review workflow captures although they lack write access. The workflow reads this
|
||||
@@ -588,9 +590,23 @@ function trustedAuthorList(value: unknown): string[] {
|
||||
function reportConfig(value: unknown): ExploreConfig["report"] {
|
||||
if (value === undefined) return undefined;
|
||||
const report = record(value, "report");
|
||||
exactKeys(report, ["preview"], "report");
|
||||
if (report.preview === undefined) return {};
|
||||
const preview = record(report.preview, "report.preview");
|
||||
exactKeys(report, ["preview", "comment"], "report");
|
||||
const comment = commentConfig(report.comment);
|
||||
const preview = previewConfig(report.preview);
|
||||
return { ...(preview ? { preview } : {}), ...(comment ? { comment } : {}) };
|
||||
}
|
||||
|
||||
function commentConfig(value: unknown): NonNullable<ExploreConfig["report"]>["comment"] {
|
||||
if (value === undefined) return undefined;
|
||||
const comment = record(value, "report.comment");
|
||||
exactKeys(comment, ["map"], "report.comment");
|
||||
if (typeof comment.map !== "boolean") fail("report.comment.map must be true or false", "report.comment.map");
|
||||
return { map: comment.map };
|
||||
}
|
||||
|
||||
function previewConfig(value: unknown): NonNullable<ExploreConfig["report"]>["preview"] {
|
||||
if (value === undefined) return undefined;
|
||||
const preview = record(value, "report.preview");
|
||||
exactKeys(preview, ["hosting", "expiresAfter", "owner", "project"], "report.preview");
|
||||
const owner = optionalText(preview.owner, "report.preview.owner", 64);
|
||||
if (owner !== undefined && !/^[a-z0-9][a-z0-9_-]*$/.test(owner)) {
|
||||
@@ -600,12 +616,12 @@ function reportConfig(value: unknown): ExploreConfig["report"] {
|
||||
if (project !== undefined && !/^[a-z0-9][a-z0-9-]*[a-z0-9]$/.test(project)) {
|
||||
fail("report.preview.project must be a lowercase EAS project slug", "report.preview.project");
|
||||
}
|
||||
return { preview: {
|
||||
return {
|
||||
hosting: literal(preview.hosting, ["eas"] as const, "report.preview.hosting"),
|
||||
expiresAfterDays: previewDays(preview.expiresAfter, "report.preview.expiresAfter"),
|
||||
...(owner === undefined ? {} : { owner }),
|
||||
...(project === undefined ? {} : { project }),
|
||||
} };
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
|
||||
@@ -2,8 +2,8 @@ import type { PublicReview } from "../contracts/capture.js";
|
||||
import type { RunTarget } from "../types.js";
|
||||
import type { SimulatorRuntimeMetadata } from "../capture/run.js";
|
||||
import { CI_COMMENT_MARKER } from "./pr-comment.js";
|
||||
import { CHANGE_GROUPS, MAX_COMMENT_TARGETS, changeCountText, compareTargets, defaultTargetLabel, foldRecord, strongerGroup, historyLine, orderedRecords, readCommentRecords, recordLabel, recordLine, recordSummary, recordTarget,
|
||||
type ChangeGroup, type CommentTarget, type CommentRecords, type HistoryEntry, type PlatformRecord } from "./pr-comment-record.js";
|
||||
import { CHANGE_GROUPS, MAX_COMMENT_TARGETS, MAX_NAVIGATION_EDGES, MAX_NAVIGATION_NODES, changeCountText, compareTargets, defaultTargetLabel, foldRecord, strongerGroup, historyLine, orderedRecords, readCommentRecords, recordLabel, recordLine, recordSummary, recordTarget,
|
||||
type ChangeGroup, type CommentNavigation, type CommentTarget, type CommentRecords, type HistoryEntry, type NavigationGroup, type NavigationKind, type PlatformRecord } from "./pr-comment-record.js";
|
||||
import { isAccessibilityOnlyChange } from "../contracts/review-validation.js";
|
||||
import type { PublicCaptureHealth, PublicEvidenceSummary } from "../review/evidence-assessment.js";
|
||||
import type { ReviewPresentation } from "../contracts/review.js";
|
||||
@@ -57,6 +57,8 @@ export type PublicCommentState = {
|
||||
artifactOnly?: boolean;
|
||||
/** The PR moved while this run worked; the comment keeps its report under previous runs. */
|
||||
superseded?: boolean;
|
||||
/** report.comment.map: draw the map of the changed screens. */
|
||||
map?: true;
|
||||
};
|
||||
|
||||
type ReviewGroup = ChangeGroup;
|
||||
@@ -310,6 +312,8 @@ export function platformRecordOf(state: PublicCommentState, target?: CommentTarg
|
||||
const scheme = schemeOf(surface.id);
|
||||
record.changes.push({ id: surface.id, route: routeOf(surface), group, description: descriptionOf(surface, group), ...(scheme ? { scheme } : {}) });
|
||||
}
|
||||
const navigation = state.map ? navigationOf(state.review, new Map(record.changes.map(change => [change.id, change.group]))) : undefined;
|
||||
if (navigation) record.navigation = navigation;
|
||||
const notCompared = state.review.surfaces.filter(notComparedChange).length;
|
||||
if (notCompared) record.notCompared = notCompared;
|
||||
record.context = contextLines(state.review).filter(line => line.length);
|
||||
@@ -336,6 +340,104 @@ export function platformRecordOf(state: PublicCommentState, target?: CommentTarg
|
||||
return record;
|
||||
}
|
||||
|
||||
const NAVIGATION_GROUPS: NavigationGroup[] = ["added", "removed", "modified"];
|
||||
const NAVIGATION_KINDS: NavigationKind[] = ["push", "replace", "navigate", "dismissTo", "redirect"];
|
||||
|
||||
/** "/p/[d]" for the route file app/(tabs)/(patterns)/p/[d].tsx: the route without its groups, which a dynamic route's variants share. */
|
||||
function routePattern(route: NonNullable<Surface["head"]>): string {
|
||||
const path = `/${route.logicalPath.replace(/^\/+/, "")}`.split("/").filter(segment => !/^\(.*\)$/.test(segment)).join("/");
|
||||
return plainText(path.replace(/\/index$/, ""), MAX_ROUTE_LENGTH) || "/";
|
||||
}
|
||||
|
||||
/**
|
||||
* The map the comment draws: every route added, removed or changed visually (a screen whose source changed but looks
|
||||
* the same is not one), the routes one step before them, and the transitions among those. A route's appearances and
|
||||
* variants are one node. Switching tabs reaches every tab from every other, so tab transitions are not edges: the
|
||||
* routes a tab switch shows are grouped instead. Removed routes and the transitions into them come from the base.
|
||||
*/
|
||||
function navigationOf(review: PublicReview, groups: Map<string, ChangeGroup>): CommentNavigation | undefined {
|
||||
if (!review.navigation) return undefined;
|
||||
const keyOf = new Map<string, string>();
|
||||
const groupOf = new Map<string, NavigationGroup>();
|
||||
for (const surface of review.surfaces) {
|
||||
const route = surface.head ?? surface.base;
|
||||
if (!route || route.kind === "redirect") continue;
|
||||
const key = routePattern(route);
|
||||
keyOf.set(surface.id.replace(/@(light|dark)$/, ""), key);
|
||||
const group = groups.get(surface.id);
|
||||
if (group !== "added" && group !== "removed" && group !== "modified") continue;
|
||||
const current = groupOf.get(key);
|
||||
if (!current || NAVIGATION_GROUPS.indexOf(group) < NAVIGATION_GROUPS.indexOf(current)) groupOf.set(key, group);
|
||||
}
|
||||
if (!groupOf.size || groupOf.size > MAX_NAVIGATION_NODES) return undefined;
|
||||
const tabs = new Set<string>();
|
||||
const links = new Map<string, { from: string; to: string; kinds: Set<NavigationKind>; base: boolean }>();
|
||||
const add = (edge: NonNullable<PublicReview["navigation"]>["head"]["edges"][number], base: boolean) => {
|
||||
const from = keyOf.get(edge.from), to = keyOf.get(edge.to);
|
||||
if (!from || !to || from === to) return;
|
||||
if (edge.kind === "tab") { tabs.add(to); return; }
|
||||
const link = links.get(`${from}\n${to}`) ?? { from, to, kinds: new Set(), base };
|
||||
link.kinds.add(edge.kind);
|
||||
links.set(`${from}\n${to}`, link);
|
||||
};
|
||||
for (const edge of review.navigation.head.edges) add(edge, false);
|
||||
for (const edge of review.navigation.base.edges) if (groupOf.get(keyOf.get(edge.to) ?? "") === "removed") add(edge, true);
|
||||
// The routes that lead to the most changed ones first, while the map has room.
|
||||
const leads = new Map<string, number>();
|
||||
for (const link of links.values()) if (groupOf.has(link.to) && !groupOf.has(link.from)) leads.set(link.from, (leads.get(link.from) ?? 0) + 1);
|
||||
const before = [...leads].sort(([a, m], [b, n]) => n - m || (a < b ? -1 : 1)).slice(0, MAX_NAVIGATION_NODES - groupOf.size).map(([key]) => key);
|
||||
const keys = [...groupOf.keys(), ...before].sort();
|
||||
const index = new Map(keys.map((key, position) => [key, position]));
|
||||
const edges = [...links.values()].filter(link => index.has(link.from) && index.has(link.to))
|
||||
.sort((a, b) => Number(groupOf.has(b.to)) - Number(groupOf.has(a.to)) || index.get(a.from)! - index.get(b.from)! || index.get(a.to)! - index.get(b.to)!)
|
||||
.slice(0, MAX_NAVIGATION_EDGES)
|
||||
.sort((a, b) => index.get(a.from)! - index.get(b.from)! || index.get(a.to)! - index.get(b.to)!)
|
||||
.map(link => ({ from: index.get(link.from)!, to: index.get(link.to)!, kinds: NAVIGATION_KINDS.filter(kind => link.kinds.has(kind)), ...(link.base ? { base: true as const } : {}) }));
|
||||
if (!edges.length) return undefined;
|
||||
return { nodes: keys.map(key => ({ route: key, ...(groupOf.has(key) ? { group: groupOf.get(key)! } : {}), ...(tabs.has(key) ? { tab: true as const } : {}) })), edges };
|
||||
}
|
||||
|
||||
/** A route as a quoted Mermaid label, with Mermaid's entity codes for what would end the label, the line or the fence. */
|
||||
function mermaidLabel(route: string): string {
|
||||
return `"${plainText(route, MAX_ROUTE_LENGTH).replace(/#/g, "#35;").replace(/"/g, "#quot;").replace(/</g, "#lt;").replace(/>/g, "#gt;").replace(/`/g, "#96;")}"`;
|
||||
}
|
||||
|
||||
/** Outlines, not fills: GitHub draws Mermaid in the reader's theme, and a fixed fill is wrong in one of them. */
|
||||
const MAP_CLASSES: Record<NavigationGroup, string> = {
|
||||
added: "stroke:#1a7f37,stroke-width:3px",
|
||||
modified: "stroke:#bc4c00,stroke-width:3px",
|
||||
removed: "stroke:#cf222e,stroke-width:2px,stroke-dasharray:5 4",
|
||||
};
|
||||
|
||||
function mermaidMap(navigation: CommentNavigation): string[] {
|
||||
const node = (index: number) => `n${index}[${mermaidLabel(navigation.nodes[index]!.route)}]`;
|
||||
const tabs = navigation.nodes.flatMap((entry, index) => entry.tab ? [index] : []);
|
||||
const lines = ["```mermaid", "flowchart LR"];
|
||||
if (tabs.length) lines.push(` subgraph tabs["Tabs"]`, ...tabs.map(index => ` ${node(index)}`), " end");
|
||||
lines.push(...navigation.nodes.flatMap((entry, index) => entry.tab ? [] : [` ${node(index)}`]));
|
||||
lines.push(...navigation.edges.map(edge => ` n${edge.from} ${edge.base ? "-.->" : "-->"}|${edge.kinds.join(", ")}| n${edge.to}`));
|
||||
for (const group of ["added", "modified", "removed"] as const) {
|
||||
const members = navigation.nodes.flatMap((entry, index) => entry.group === group ? [`n${index}`] : []);
|
||||
if (members.length) lines.push(` classDef ${group} ${MAP_CLASSES[group]}`, ` class ${members.join(",")} ${group}`);
|
||||
}
|
||||
return [...lines, "```"];
|
||||
}
|
||||
|
||||
/** One collapsed map per distinct navigation: targets with the same routes share one, named when the targets' maps differ. */
|
||||
function mapSection(ready: PlatformRecord[]): string[] {
|
||||
const maps = new Map<string, { navigation: CommentNavigation; records: PlatformRecord[] }>();
|
||||
for (const record of ready) {
|
||||
if (!record.navigation) continue;
|
||||
const key = JSON.stringify(record.navigation);
|
||||
maps.set(key, { navigation: record.navigation, records: [...(maps.get(key)?.records ?? []), record] });
|
||||
}
|
||||
return [...maps.values()].flatMap(({ navigation, records }) => {
|
||||
const named = maps.size > 1 || records.length < ready.length ? `${records.map(labelOf).join(" · ")} · ` : "";
|
||||
return details(`${named}Map (${plural(navigation.nodes.length, "screen")})`, ["", ...mermaidMap(navigation), "",
|
||||
"Outlined: green added, orange changed, red dashed removed; the others lead to them. Tabs groups the screens a tab switch shows.", ""]);
|
||||
});
|
||||
}
|
||||
|
||||
const commitLink = (repository: string, sha: string) => link(inlineText(sha.slice(0, 8), 8), `https://github.com/${repository.split("/").map(encodeURIComponent).join("/")}/commit/${encodeURIComponent(sha)}`);
|
||||
|
||||
function surfaceLink(report: string, id: string): string | undefined {
|
||||
@@ -431,7 +533,7 @@ function renderChangeRow(row: ChangeRow, records: PlatformRecord[]): string {
|
||||
return `- ${route} — ${inlineText(row.description, MAX_DESCRIPTION_LENGTH)}${where.length ? ` · ${where.join(" · ")}` : ""}`;
|
||||
}
|
||||
|
||||
function changesSection(records: PlatformRecord[], rowCap: number): string[] {
|
||||
function changesSection(records: PlatformRecord[], rowCap: number, withMap: boolean): string[] {
|
||||
const ready = records.filter(record => record.phase === "ready");
|
||||
if (!ready.length) return [];
|
||||
const groups = changeRows(ready);
|
||||
@@ -454,6 +556,7 @@ function changesSection(records: PlatformRecord[], rowCap: number): string[] {
|
||||
content.push("");
|
||||
lines.push(...details(`${GROUP_LABEL[group]} (${rows.length})`, content));
|
||||
}
|
||||
if (withMap) lines.push(...mapSection(ready));
|
||||
const seen = new Set<string>();
|
||||
for (const record of ready) for (const line of record.context ?? []) {
|
||||
if (seen.has(line)) continue;
|
||||
@@ -594,13 +697,13 @@ export function renderCommentRecords(records: CommentRecords, existing?: string,
|
||||
...historySection("", records.history)].join("\n");
|
||||
const first = current[0]!;
|
||||
const repository = repositoryOf(first.links.run);
|
||||
const render = (rowCap: number): string => {
|
||||
const render = (rowCap: number, withMap: boolean): string => {
|
||||
const lines: string[] = [...hidden, heading(current), "",
|
||||
`<sub>base ${commitLink(repository, first.baseSha)} → ${commitLink(repository, first.headSha)}</sub>`, ""];
|
||||
if (first.superseded) lines.push(SUPERSEDED_NOTE, "");
|
||||
lines.push(`| | Device | Result | Report |`, `|---|---|---|---|`,
|
||||
...current.map(record => `| ${labelOf(record)} | ${deviceCell(record)} | ${resultCell(record)} | ${reportCell(record)} |`), "");
|
||||
lines.push(...changesSection(current, rowCap));
|
||||
lines.push(...changesSection(current, rowCap, withMap));
|
||||
lines.push(...validationSection(current));
|
||||
lines.push(...historySection(repository, records.history));
|
||||
const expiries = current.filter(record => record.phase === "ready" && record.links.expiresAt !== undefined).map(record => record.links.expiresAt);
|
||||
@@ -613,9 +716,11 @@ export function renderCommentRecords(records: CommentRecords, existing?: string,
|
||||
lines.push(footer.join(" · "));
|
||||
return lines.join("\n");
|
||||
};
|
||||
// The map goes first when the body is over budget, then the change lists shrink.
|
||||
let rowCap = MAX_ROWS_PER_GROUP;
|
||||
let body = render(rowCap);
|
||||
while (body.length > budget && rowCap > 1) { rowCap = Math.max(1, Math.floor(rowCap / 2)); body = render(rowCap); }
|
||||
let body = render(rowCap, true);
|
||||
if (body.length > budget) body = render(rowCap, false);
|
||||
while (body.length > budget && rowCap > 1) { rowCap = Math.max(1, Math.floor(rowCap / 2)); body = render(rowCap, false); }
|
||||
return body;
|
||||
}
|
||||
|
||||
|
||||
@@ -56,6 +56,23 @@ export function changeCountText(groups: readonly ChangeGroup[]): string {
|
||||
return [visual ? `${visual} visual change${visual === 1 ? "" : "s"}` : undefined, `${accessibility} accessibility only`].filter(Boolean).join(" · ");
|
||||
}
|
||||
|
||||
export type NavigationGroup = "added" | "modified" | "removed";
|
||||
export type NavigationKind = "push" | "replace" | "navigate" | "redirect" | "tab" | "dismissTo";
|
||||
const NAVIGATION_GROUPS: NavigationGroup[] = ["added", "modified", "removed"];
|
||||
const NAVIGATION_KINDS: NavigationKind[] = ["push", "replace", "navigate", "redirect", "tab", "dismissTo"];
|
||||
export const MAX_NAVIGATION_NODES = 30;
|
||||
export const MAX_NAVIGATION_EDGES = 80;
|
||||
|
||||
/**
|
||||
* The comment's map: one node per route that was added, removed or changed visually, and per route one step before
|
||||
* one of them; edges index `nodes`. `tab` marks a route a tab switch shows, `base` an edge into a removed route, which
|
||||
* only the base revision's navigation has.
|
||||
*/
|
||||
export type CommentNavigation = {
|
||||
nodes: { route: string; group?: NavigationGroup; tab?: true }[];
|
||||
edges: { from: number; to: number; kinds: NavigationKind[]; base?: true }[];
|
||||
};
|
||||
|
||||
export type SideHealth = { planned: number; captured: number; verified: number; unverified: number; unavailable: number };
|
||||
|
||||
export type PlatformRecord = {
|
||||
@@ -92,6 +109,7 @@ export type PlatformRecord = {
|
||||
notCompared?: number;
|
||||
/** Differences stated once rather than per screen (variants, app-wide source changes). */
|
||||
context?: string[];
|
||||
navigation?: CommentNavigation;
|
||||
diagnostics?: { side?: "base" | "head"; route: string; code: string; message: string; nextAction: string }[];
|
||||
diagnosticCount?: number;
|
||||
failure?: { step: string; message: string };
|
||||
@@ -236,6 +254,8 @@ export function parsePlatformRecord(value: unknown): PlatformRecord | undefined
|
||||
? [{ id: entry.id, route: entry.route, group: entry.group as ChangeGroup, description: entry.description, ...(isString(entry.scheme, 20) ? { scheme: entry.scheme } : {}) }] : []);
|
||||
if (changes.length <= 2000) record.changes = changes;
|
||||
}
|
||||
const navigation = parseNavigation(value.navigation);
|
||||
if (navigation) record.navigation = navigation;
|
||||
if (Array.isArray(value.context)) record.context = value.context.filter((entry): entry is string => isString(entry, 2000)).slice(0, 10);
|
||||
if (Array.isArray(value.diagnostics)) {
|
||||
record.diagnostics = value.diagnostics.flatMap((entry): NonNullable<PlatformRecord["diagnostics"]> => isRecord(entry) && isString(entry.route, 2000) && isString(entry.code, 200)
|
||||
@@ -249,6 +269,25 @@ export function parsePlatformRecord(value: unknown): PlatformRecord | undefined
|
||||
return record;
|
||||
}
|
||||
|
||||
function parseNavigation(value: unknown): CommentNavigation | undefined {
|
||||
if (!isRecord(value) || !Array.isArray(value.nodes) || !Array.isArray(value.edges) || value.nodes.length > MAX_NAVIGATION_NODES
|
||||
|| value.edges.length > MAX_NAVIGATION_EDGES) return undefined;
|
||||
const nodes: CommentNavigation["nodes"] = [];
|
||||
for (const node of value.nodes) {
|
||||
if (!isRecord(node) || !isString(node.route, 200) || !optional(node.group, (group): group is NavigationGroup => NAVIGATION_GROUPS.includes(group as NavigationGroup))
|
||||
|| !(node.tab === undefined || node.tab === true)) return undefined;
|
||||
nodes.push({ route: node.route, ...(node.group ? { group: node.group } : {}), ...(node.tab ? { tab: true } : {}) });
|
||||
}
|
||||
const edges: CommentNavigation["edges"] = [];
|
||||
const isNode = (index: unknown): index is number => isCount(index) && index < nodes.length;
|
||||
for (const edge of value.edges) {
|
||||
if (!isRecord(edge) || !isNode(edge.from) || !isNode(edge.to) || !Array.isArray(edge.kinds) || !edge.kinds.length
|
||||
|| !edge.kinds.every(kind => NAVIGATION_KINDS.includes(kind as NavigationKind)) || !(edge.base === undefined || edge.base === true)) return undefined;
|
||||
edges.push({ from: edge.from, to: edge.to, kinds: [...new Set(edge.kinds as NavigationKind[])], ...(edge.base ? { base: true } : {}) });
|
||||
}
|
||||
return nodes.length && edges.length ? { nodes, edges } : undefined;
|
||||
}
|
||||
|
||||
export function parseHistory(value: unknown): HistoryEntry[] {
|
||||
if (!Array.isArray(value)) return [];
|
||||
const entries: HistoryEntry[] = [];
|
||||
|
||||
@@ -1491,8 +1491,19 @@ test("Esc closes the Inspector first, then deselects; arrows and hjkl walk the m
|
||||
await expect(selected).toHaveCount(0);
|
||||
await expect(page).toHaveURL(/\/map$/);
|
||||
|
||||
// Nothing selected: the arrows are not map moves.
|
||||
await page.keyboard.press("ArrowDown");
|
||||
// Nothing selected: ↓ enters the map at its top, as → enters Screens at its first card; held, it
|
||||
// keeps walking down from there and stops where it is on release.
|
||||
await page.keyboard.down("ArrowDown");
|
||||
await expect(selected).toHaveCount(1);
|
||||
const entered = await selected.getAttribute("data-id");
|
||||
await expect.poll(() => selected.getAttribute("data-id"), { timeout: 4000 }).not.toBe(entered);
|
||||
await page.keyboard.up("ArrowDown");
|
||||
const walkedTo = await selected.getAttribute("data-id");
|
||||
await page.waitForTimeout(500);
|
||||
await expect(selected).toHaveAttribute("data-id", walkedTo!);
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(page.locator(".right-panel")).toHaveCount(0);
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(selected).toHaveCount(0);
|
||||
|
||||
await page.locator(".map-canvas .react-flow__node-screen .screen-screenshot-target").first().click();
|
||||
@@ -1508,6 +1519,67 @@ test("Esc closes the Inspector first, then deselects; arrows and hjkl walk the m
|
||||
await expect(selected).toHaveAttribute("data-id", child!);
|
||||
});
|
||||
|
||||
test("a held key stops when Esc, another key or a dialog takes the keyboard; a menu keeps its own arrows", async ({ page }) => {
|
||||
await page.goto("/map");
|
||||
const selected = page.locator(".map-canvas .react-flow__node-screen.selected");
|
||||
const inspector = page.locator(".right-panel");
|
||||
const search = page.getByRole("dialog", { name: "Search Explore" });
|
||||
const viewport = page.locator(".map-canvas .react-flow__viewport");
|
||||
const mod = process.platform === "darwin" ? "Meta" : "Control";
|
||||
|
||||
// Nothing selected and a menu open: ← and → on its item are the menu's, not the map's.
|
||||
await expect(selected).toHaveCount(0);
|
||||
await page.locator(".zoom-button").click();
|
||||
await expect(page.getByRole("menu")).toBeVisible();
|
||||
await page.keyboard.press("ArrowDown");
|
||||
await page.keyboard.press("ArrowLeft");
|
||||
await page.keyboard.press("ArrowRight");
|
||||
await expect(selected).toHaveCount(0);
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(page.getByRole("menu")).toHaveCount(0);
|
||||
|
||||
// Esc mid-walk closes the Inspector, and the walk does not reopen it on its next step.
|
||||
await page.locator(".map-canvas .react-flow__node-screen .screen-screenshot-target").first().click();
|
||||
await expect(inspector).toBeVisible();
|
||||
await page.keyboard.down("ArrowDown");
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(inspector).toHaveCount(0);
|
||||
await page.waitForTimeout(800);
|
||||
await expect(inspector).toHaveCount(0);
|
||||
await page.keyboard.up("ArrowDown");
|
||||
|
||||
// ⌘K mid-walk opens Search, and the selection behind it stays where it was.
|
||||
await page.keyboard.down("ArrowDown");
|
||||
await page.keyboard.press(`${mod}+k`);
|
||||
await expect(search).toBeVisible();
|
||||
const behind = await selected.getAttribute("data-id");
|
||||
await page.waitForTimeout(800);
|
||||
await expect(selected).toHaveAttribute("data-id", behind!);
|
||||
await page.keyboard.up("ArrowDown");
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(search).toHaveCount(0);
|
||||
|
||||
// A held + glides past the tap's one step and stops where it is on release.
|
||||
const zoomNow = async () => (await readCanvasCamera(viewport)).zoom;
|
||||
const before = await zoomNow();
|
||||
await page.keyboard.down("Equal");
|
||||
await expect.poll(zoomNow, { timeout: 4000 }).toBeGreaterThan(before * 1.2 * 1.2);
|
||||
await page.keyboard.up("Equal");
|
||||
const released = await zoomNow();
|
||||
await page.waitForTimeout(300);
|
||||
expect(await zoomNow()).toBeCloseTo(released, 3);
|
||||
|
||||
// Held −, then a click opens Search: the glide stops rather than zoom behind the dialog.
|
||||
await page.keyboard.down("Minus");
|
||||
await page.getByRole("button", { name: "Search", exact: true }).click();
|
||||
await expect(search).toBeVisible();
|
||||
await page.waitForTimeout(400);
|
||||
const atOpen = await zoomNow();
|
||||
await page.waitForTimeout(800);
|
||||
expect(await zoomNow()).toBeCloseTo(atOpen, 3);
|
||||
await page.keyboard.up("Minus");
|
||||
});
|
||||
|
||||
test("a drag that starts on a transition edge pans the map", async ({ page }) => {
|
||||
await page.goto("/map");
|
||||
const viewport = page.locator(".map-canvas .react-flow__viewport");
|
||||
@@ -2040,16 +2112,12 @@ test("canonicalizes the legacy Workspace route to Changes and reports the exact
|
||||
if (entry.status === "unchanged") return total;
|
||||
return total + (entry.currentScreenIds.length || entry.baselineScreenIds.length);
|
||||
}, 0);
|
||||
// The bottom bar's Compare button carries the count.
|
||||
const badge = page.locator(".canvas-toolbar .toolbar-badge");
|
||||
await expect(badge).toHaveText(String(expectedChanges));
|
||||
const menu = await openChangesMenu(page);
|
||||
await expect(menu.locator(".changes-panel-title .changes-panel-count")).toHaveText(String(expectedChanges));
|
||||
|
||||
// Without a baseline there is nothing to count. Compare still opens, and the view says why it is empty.
|
||||
await page.goto("/map?baseline=none");
|
||||
await expect(page).toHaveURL(/baseline=none/);
|
||||
await expect(badge).toHaveCount(0);
|
||||
const compare = page.getByRole("toolbar", { name: "Canvas tools" }).getByRole("button", { name: "Compare", exact: true });
|
||||
await expect(compare).not.toHaveAttribute("aria-disabled", "true");
|
||||
await compare.click();
|
||||
@@ -2700,6 +2768,31 @@ test("drives the shell from the keyboard, and says so on hover", async ({ page }
|
||||
}
|
||||
await expect(page.getByRole("button", { name: "Comments", exact: true })).toHaveCount(0);
|
||||
|
||||
// A held modifier shows, on each button it makes a chord with, the key that completes it: ⇧ puts
|
||||
// 1 on Fit canvas, ⌘ (Ctrl elsewhere) puts K on Search. Released, the hints go.
|
||||
const hints = page.locator(".key-hint");
|
||||
await expect(hints).toHaveCount(0);
|
||||
await page.keyboard.down("Shift");
|
||||
await expect(page.getByRole("button", { name: "Fit canvas" }).locator(".key-hint")).toHaveText("1");
|
||||
await expect(page.getByRole("button", { name: "Center canvas" }).locator(".key-hint")).toHaveText("2");
|
||||
await expect(page.getByRole("button", { name: "Search", exact: true }).locator(".key-hint")).toHaveCount(0);
|
||||
await page.keyboard.up("Shift");
|
||||
await expect(hints).toHaveCount(0);
|
||||
await page.keyboard.down(mod);
|
||||
await expect(page.getByRole("button", { name: "Search", exact: true }).locator(".key-hint")).toHaveText("K");
|
||||
await expect(page.getByRole("button", { name: "Fit canvas" }).locator(".key-hint")).toHaveCount(0);
|
||||
await page.keyboard.up(mod);
|
||||
await expect(hints).toHaveCount(0);
|
||||
// Focus that moves into a field by mouse, with ⇧ still down, takes the hints with it.
|
||||
await page.keyboard.down("Shift");
|
||||
await expect(page.getByRole("button", { name: "Fit canvas" }).locator(".key-hint")).toHaveText("1");
|
||||
await page.getByRole("button", { name: "Search", exact: true }).click();
|
||||
await expect(page.getByRole("dialog", { name: "Search Explore" })).toBeVisible();
|
||||
await expect(hints).toHaveCount(0);
|
||||
await page.keyboard.up("Shift");
|
||||
await page.keyboard.press("Escape");
|
||||
await expect(page.getByRole("dialog", { name: "Search Explore" })).toHaveCount(0);
|
||||
|
||||
// ⌘B opens and closes the Changes menu.
|
||||
await page.keyboard.press(`${mod}+b`);
|
||||
await expect(page.locator(".changes-menu")).toBeVisible();
|
||||
@@ -2732,14 +2825,23 @@ test("drives the shell from the keyboard, and says so on hover", async ({ page }
|
||||
await expect(page.locator(".tooltip-key")).toHaveText("C");
|
||||
await page.getByRole("button", { name: "Expand inspector" }).hover();
|
||||
await expect(page.locator(".tooltip-key")).toHaveText("I");
|
||||
// The theme button has no key: it names the mode in force and nothing else.
|
||||
// The theme button names the mode in force, and T is its key.
|
||||
const themeButton = page.getByRole("button", { name: "Toggle theme" });
|
||||
await themeButton.hover();
|
||||
await expect(page.locator(".tooltip-content")).toContainText("Theme:");
|
||||
await expect(page.locator(".tooltip-key")).toHaveCount(0);
|
||||
await expect(page.locator(".tooltip-content")).toContainText("Theme: Auto");
|
||||
await expect(page.locator(".tooltip-key")).toHaveText("T");
|
||||
await page.mouse.move(0, 0);
|
||||
const initialTheme = await page.locator("html").getAttribute("data-theme");
|
||||
expect(initialTheme === "light" || initialTheme === "dark").toBe(true);
|
||||
const otherTheme = initialTheme === "dark" ? "light" : "dark";
|
||||
// T flips between dark and light from whatever Auto showed, and never steps back to Auto.
|
||||
await page.keyboard.press("t");
|
||||
await expect(page.locator("html")).toHaveAttribute("data-theme", otherTheme);
|
||||
await page.keyboard.press("t");
|
||||
await expect(page.locator("html")).toHaveAttribute("data-theme", initialTheme!);
|
||||
await themeButton.hover();
|
||||
await expect(page.locator(".tooltip-content")).toContainText(initialTheme === "dark" ? "Theme: Dark" : "Theme: Light");
|
||||
await page.mouse.move(0, 0);
|
||||
// The retired theme and inspector chords no longer answer.
|
||||
await page.keyboard.press(`${mod}+Alt+t`);
|
||||
await expect(page.locator("html")).toHaveAttribute("data-theme", initialTheme!);
|
||||
@@ -4202,6 +4304,25 @@ test("desktop Compare: one command bar with the modes in it, even gaps to both b
|
||||
for (let step = 1; step < before; step += 1) await page.keyboard.press("ArrowRight");
|
||||
await expect(position).toHaveText(new RegExp(`^${before} of `));
|
||||
|
||||
// In Swipe, [ and ] nudge the divider; held, ] keeps going until it is released or at the edge.
|
||||
await page.keyboard.press("2");
|
||||
const divider = compare.getByRole("slider");
|
||||
await expect(divider).toHaveAttribute("aria-valuenow", "50");
|
||||
await page.keyboard.press("BracketLeft");
|
||||
await expect(divider).toHaveAttribute("aria-valuenow", "45");
|
||||
const dividerAt = async () => Number(await divider.getAttribute("aria-valuenow"));
|
||||
await page.keyboard.down("BracketRight");
|
||||
await expect(divider).toHaveAttribute("aria-valuenow", "50");
|
||||
await expect.poll(dividerAt, { timeout: 4000 }).toBeGreaterThanOrEqual(65);
|
||||
await page.keyboard.up("BracketRight");
|
||||
const dividerHeld = await dividerAt();
|
||||
await page.waitForTimeout(600);
|
||||
expect(await dividerAt()).toBe(dividerHeld);
|
||||
await page.keyboard.down("BracketRight");
|
||||
await expect.poll(dividerAt, { timeout: 8000 }).toBe(100);
|
||||
await page.keyboard.up("BracketRight");
|
||||
await page.keyboard.press("1");
|
||||
|
||||
// The bar keeps one size whatever the route, so Next stays under the pointer: it can be clicked
|
||||
// again and again through screens whose routes differ in length.
|
||||
const nextButton = bar.getByRole("button", { name: "Next changed screen" });
|
||||
|
||||
@@ -191,6 +191,15 @@ test("report.preview opts into hosted previews with a bounded expiry and an opti
|
||||
assert.throws(() => validateExploreConfig({ ...base(), report: { hosting: "eas" } }), /report/);
|
||||
});
|
||||
|
||||
test("report.comment.map opts the PR comment into its map of changed screens, beside or without a hosted preview", () => {
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { comment: { map: true } } }).report, { comment: { map: true } });
|
||||
assert.deepEqual(validateExploreConfig({ ...base(), report: { comment: { map: false }, preview: { hosting: "eas" } } }).report,
|
||||
{ comment: { map: false }, preview: { hosting: "eas", expiresAfterDays: 30 } });
|
||||
for (const comment of [{}, { map: "yes" }, { map: true, graph: true }, true]) {
|
||||
assert.throws(() => validateExploreConfig({ ...base(), report: { comment } }), /Invalid .expo-explore\/config.yaml: report.comment/);
|
||||
}
|
||||
});
|
||||
|
||||
test("platforms: a flat config is iOS-only and resolves to itself", () => {
|
||||
const config = validateExploreConfig(base());
|
||||
assert.deepEqual(configPlatforms(config), ["ios"]);
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
|
||||
const { tsImport } = await import("tsx/esm/api");
|
||||
const { heldKeyHint, shortcutModifiers } = await tsImport("../../viewer/src/utils/held-modifiers.ts", import.meta.url);
|
||||
const { SHORTCUTS } = await tsImport("../../viewer/src/utils/shortcuts.ts", import.meta.url);
|
||||
|
||||
const held = (keys) => ({ shift: false, ctrl: false, meta: false, alt: false, ...keys });
|
||||
|
||||
test("holding a chord's modifiers shows the key that completes it; anything else shows nothing", () => {
|
||||
assert.equal(heldKeyHint(SHORTCUTS.canvasByNumber.map, held({ ctrl: true }), true), "1");
|
||||
assert.equal(heldKeyHint(SHORTCUTS.canvasByNumber.compare, held({ ctrl: true }), true), "3");
|
||||
assert.equal(heldKeyHint(SHORTCUTS.camera.fit, held({ shift: true }), true), "1");
|
||||
assert.equal(heldKeyHint(SHORTCUTS.appearance.app, held({ shift: true }), true), "T");
|
||||
assert.equal(heldKeyHint(SHORTCUTS.canvasByNumber.map, held({ shift: true }), true), undefined, "the wrong modifier");
|
||||
assert.equal(heldKeyHint(SHORTCUTS.canvasByNumber.map, held({ ctrl: true, shift: true }), true), undefined, "an extra modifier");
|
||||
assert.equal(heldKeyHint(SHORTCUTS.canvas.map, held({ ctrl: true }), true), undefined, "a plain key has no chord");
|
||||
assert.equal(heldKeyHint(SHORTCUTS.canvasByNumber.map, held({}), true), undefined, "nothing held");
|
||||
});
|
||||
|
||||
test("mod is ⌘ on Apple keyboards and Ctrl elsewhere", () => {
|
||||
assert.equal(heldKeyHint(SHORTCUTS.app.search, held({ meta: true }), true), "K");
|
||||
assert.equal(heldKeyHint(SHORTCUTS.app.search, held({ ctrl: true }), true), undefined);
|
||||
assert.equal(heldKeyHint(SHORTCUTS.app.search, held({ ctrl: true }), false), "K");
|
||||
assert.equal(heldKeyHint(SHORTCUTS.app.search, held({ meta: true }), false), undefined);
|
||||
assert.deepEqual(shortcutModifiers(SHORTCUTS.app.search, true), held({ meta: true }));
|
||||
assert.deepEqual(shortcutModifiers(SHORTCUTS.app.search, false), held({ ctrl: true }));
|
||||
});
|
||||
@@ -2,7 +2,7 @@ import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
|
||||
const { tsImport } = await import("tsx/esm/api");
|
||||
const { HOLD_INITIAL_DELAY_MS, HOLD_FIRST_INTERVAL_MS, HOLD_FLOOR_INTERVAL_MS, holdIntervalMs, holdSchedule } =
|
||||
const { HOLD_INITIAL_DELAY_MS, HOLD_FIRST_INTERVAL_MS, HOLD_FLOOR_INTERVAL_MS, createKeyHold, glideRate, holdIntervalMs, holdSchedule } =
|
||||
await tsImport("../../viewer/src/utils/key-hold.ts", import.meta.url);
|
||||
|
||||
test("a held paging key waits, then steps sooner and sooner down to a floor", () => {
|
||||
@@ -16,3 +16,70 @@ test("a held paging key waits, then steps sooner and sooner down to a floor", ()
|
||||
assert.ok(schedule.at(-1) < 2000, "six held steps fit in two seconds");
|
||||
assert.ok(HOLD_INITIAL_DELAY_MS > HOLD_FIRST_INTERVAL_MS, "the hold begins slower than it repeats");
|
||||
});
|
||||
|
||||
test("a held key steps on the schedule from its first step, and ends when a step finds nothing", (t) => {
|
||||
t.mock.timers.enable({ apis: ["setTimeout"] });
|
||||
const hold = createKeyHold();
|
||||
let steps = 0;
|
||||
hold.begin("ArrowRight", () => (steps += 1) < 3);
|
||||
assert.ok(hold.holding("ArrowRight"));
|
||||
assert.ok(!hold.holding("ArrowLeft"));
|
||||
t.mock.timers.tick(HOLD_INITIAL_DELAY_MS - 1);
|
||||
assert.equal(steps, 0, "nothing before the initial delay");
|
||||
t.mock.timers.tick(1);
|
||||
assert.equal(steps, 1, "the second step lands after the initial delay");
|
||||
t.mock.timers.tick(holdIntervalMs(1));
|
||||
assert.equal(steps, 2);
|
||||
t.mock.timers.tick(holdIntervalMs(2));
|
||||
assert.equal(steps, 3, "the third attempt finds nothing");
|
||||
assert.ok(!hold.holding("ArrowRight"), "and the hold ends by itself");
|
||||
t.mock.timers.tick(10_000);
|
||||
assert.equal(steps, 3, "no further steps");
|
||||
});
|
||||
|
||||
test("ending a hold, or beginning another key, stops the first", (t) => {
|
||||
t.mock.timers.enable({ apis: ["setTimeout"] });
|
||||
const hold = createKeyHold();
|
||||
let right = 0;
|
||||
let left = 0;
|
||||
hold.begin("ArrowRight", () => { right += 1; return true; });
|
||||
t.mock.timers.tick(HOLD_INITIAL_DELAY_MS);
|
||||
assert.equal(right, 1);
|
||||
hold.begin("ArrowLeft", () => { left += 1; return true; });
|
||||
assert.ok(!hold.holding("ArrowRight"));
|
||||
assert.ok(hold.holding("ArrowLeft"));
|
||||
// Mock timers run one scheduled round per tick; a hold schedules the next step from each step.
|
||||
t.mock.timers.tick(HOLD_INITIAL_DELAY_MS);
|
||||
t.mock.timers.tick(holdIntervalMs(1));
|
||||
assert.equal(right, 1, "the first key stopped stepping");
|
||||
assert.equal(left, 2);
|
||||
hold.end();
|
||||
assert.ok(!hold.holding("ArrowLeft"));
|
||||
t.mock.timers.tick(holdIntervalMs(2));
|
||||
t.mock.timers.tick(1000);
|
||||
assert.equal(left, 2);
|
||||
});
|
||||
|
||||
test("another key ends a hold, as the OS's own repeat stops; its own repeats and a modifier do not", () => {
|
||||
const key = (code, key = code, repeat = false) => ({ code, key, repeat });
|
||||
const hold = createKeyHold();
|
||||
hold.begin("ArrowDown", () => true);
|
||||
hold.interrupt(key("ArrowDown", "ArrowDown", true));
|
||||
hold.interrupt(key("ShiftLeft", "Shift"));
|
||||
hold.interrupt(key("MetaLeft", "Meta"));
|
||||
assert.ok(hold.holding("ArrowDown"), "its own repeat and a modifier leave it held");
|
||||
hold.interrupt(key("Escape"));
|
||||
assert.ok(!hold.holding("ArrowDown"), "Esc ends it");
|
||||
hold.begin("ArrowDown", () => true);
|
||||
hold.interrupt(key("KeyK", "k"));
|
||||
assert.ok(!hold.holding("ArrowDown"), "so does the K of ⌘K");
|
||||
hold.end();
|
||||
});
|
||||
|
||||
test("a glide picks up from rest, then eases from the stepped hold's first speed up to its top speed", () => {
|
||||
assert.equal(glideRate(0), 0, "it starts at rest, where the tap's step ended");
|
||||
assert.ok(Math.abs(glideRate(80) - 1000 / HOLD_FIRST_INTERVAL_MS) < 0.2, "within a few frames it moves a step per first interval");
|
||||
for (let at = 10; at <= 1200; at += 10) assert.ok(glideRate(at) >= glideRate(at - 10), `never slows, at ${at}ms`);
|
||||
assert.equal(glideRate(1000), 1000 / HOLD_FLOOR_INTERVAL_MS, "after a second, a step per floor interval");
|
||||
assert.equal(glideRate(5000), glideRate(1000), "and no faster");
|
||||
});
|
||||
@@ -2,7 +2,7 @@ import assert from "node:assert/strict";
|
||||
import test from "node:test";
|
||||
|
||||
const { tsImport } = await import("tsx/esm/api");
|
||||
const { mapKeyDirection, mapKeyTarget } = await tsImport("../../viewer/src/utils/map-keyboard.ts", import.meta.url);
|
||||
const { mapKeyDirection, mapKeyEntry, mapKeyTarget } = await tsImport("../../viewer/src/utils/map-keyboard.ts", import.meta.url);
|
||||
|
||||
// A top-to-bottom map: root fans out to a, b, c on one rank; b leads on to d; e is a stray rank with no edges.
|
||||
// root
|
||||
@@ -100,3 +100,11 @@ test("a left-to-right map needs no special case: the keys read positions", () =>
|
||||
assert.equal(mapKeyTarget(rotated, "a", "down"), "b");
|
||||
assert.equal(mapKeyTarget(rotated, "c", "up"), "b");
|
||||
});
|
||||
|
||||
test("with nothing selected, an arrow enters the map at the edge it moves away from, as Screens' arrows do", () => {
|
||||
assert.equal(mapKeyEntry(structure, "down"), "root", "down starts at the top");
|
||||
assert.equal(mapKeyEntry(structure, "up"), "d", "up starts at the bottom; the leftmost of that rank");
|
||||
assert.equal(mapKeyEntry(structure, "right"), "a", "right starts at the left edge");
|
||||
assert.equal(mapKeyEntry(structure, "left"), "e", "left starts at the right edge");
|
||||
assert.equal(mapKeyEntry({ positions: new Map() }, "down"), undefined, "an empty map has no entry");
|
||||
});
|
||||
@@ -31,8 +31,10 @@ for (const provider of ['expo-router', 'react-navigation']) {
|
||||
const before = f.requests.length;
|
||||
const output = join(f.root, 'review');
|
||||
const result = await runPublicCi({ baseProject: f.baseProject, headProject: f.headProject, pullRequestPath: f.pullRequestPath, output,
|
||||
config: f.config, environment: { ...f.environment, EXPLORE_CAPTURE_CACHE: baseline.directory }, transport: f.transport, runner: f.runner, now: f.now, sleep: f.sleep });
|
||||
config: { ...f.config, report: { comment: { map: true } } }, environment: { ...f.environment, EXPLORE_CAPTURE_CACHE: baseline.directory },
|
||||
transport: f.transport, runner: f.runner, now: f.now, sleep: f.sleep });
|
||||
const plan = JSON.parse(await readFile(join(output, 'execution-plan.json'), 'utf8'));
|
||||
assert.equal(JSON.parse(await readFile(result.inputPath, 'utf8')).commentState.map, true, 'report.comment.map reaches the comment the publish job renders');
|
||||
assert.equal(result.review.contract, 'explore.review');
|
||||
assert.equal(result.review.runtime.appVersion, '3.0.0', 'the Viewer header shows the captured app version');
|
||||
assert.equal(result.review.runtime.appBuildNumber, '7', 'the Viewer header shows the captured build number');
|
||||
@@ -122,6 +124,7 @@ test('unreachable screens do not fail CI: both revisions, the report and an Inco
|
||||
.map(line => line.replace('(home)', `(${result.review.surfaces.find(surface => surface.head?.route === '/home')?.id})`)).sort());
|
||||
assert.ok(progress.includes('2 screens are unavailable in this report'));
|
||||
const reportInput = JSON.parse(await readFile(join(output, 'report-input.json'), 'utf8'));
|
||||
assert.equal(reportInput.commentState.map, undefined, 'the comment draws no map unless the config asks for one');
|
||||
assert.equal(reportInput.publicReview.surfaces.filter(surface => surface.headOutcome && surface.headOutcome.status !== 'captured').length, 0);
|
||||
assert.equal(reportInput.publicReview.surfaces.filter(surface => surface.headOutcome?.landing === 'unverified' && surface.headImage).length, 1);
|
||||
assert.equal(reportInput.publicReview.surfaces.filter(surface => surface.baseOutcome && surface.baseOutcome.status !== 'captured').length, 1);
|
||||
|
||||
@@ -588,3 +588,57 @@ test('a comment written by a per-platform version keeps parsing, and malformed t
|
||||
const many = Array.from({ length: 10 }, (_, index) => line(`t${index}`, { ...valid, target: `t${index}` }));
|
||||
assert.equal(parse(...many).length, 8, 'a comment holds at most one record per configurable target');
|
||||
});
|
||||
|
||||
test('with report.comment.map, the map draws the added, removed and visually changed screens, the screens one step before them, and tabs as a group', async () => {
|
||||
const { readCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const edge = (from, to, kind) => ({ from, to, kind, sourceFile: 'src/app/_layout.tsx', provenance: 'source' });
|
||||
const graph = edges => ({ contract: 'explore.navigation', edges, modalSurfaceIds: [], unresolved: [] });
|
||||
const base = evidenceReview();
|
||||
const dark = surface('settings@dark', 'modified', { route: '/settings', extra: base.surfaces[2].review && { review: base.surfaces[2].review, visual: base.surfaces[2].visual } });
|
||||
const withNavigation = { ...base, surfaces: [...base.surfaces, dark], navigation: {
|
||||
// home is a redirect, not a screen; cats and settings are tabs; cats changed only in source, so it is drawn as the way to care-guide.
|
||||
head: graph([edge('cats', 'care-guide', 'push'), edge('cats', 'settings', 'tab'), edge('settings', 'cats', 'tab'), edge('home', 'cats', 'replace')]),
|
||||
base: graph([edge('cats', 'sweet-bee', 'push'), edge('cats', 'settings', 'tab')]),
|
||||
} };
|
||||
// Off by default: most reviews do not need it, so a config opts in with report.comment.map.
|
||||
assert.ok(!/<summary>Map/.test(renderPublicComment(state({ artifactOnly: true, review: withNavigation }))));
|
||||
assert.equal(platformRecordOf(state({ review: withNavigation })).navigation, undefined);
|
||||
const body = renderPublicComment(state({ artifactOnly: true, map: true, review: withNavigation }));
|
||||
assert.deepEqual(summaries(body), ['🟩 Added (1)', '🟥 Removed (1)', '🟧 Modified (2)', 'Map (4 screens)', 'Validation · iOS 🟩 8/8 captured']);
|
||||
const map = body.slice(body.indexOf('```mermaid'), body.indexOf('```\n', body.indexOf('```mermaid')) + 3);
|
||||
assert.equal(map, ['```mermaid', 'flowchart LR', ' subgraph tabs["Tabs"]', ' n0["/cats"]', ' n3["/settings"]', ' end',
|
||||
' n1["/cats/care-guide"]', ' n2["/cats/sweet-bee"]', ' n0 -->|push| n1', ' n0 -.->|push| n2',
|
||||
' classDef added stroke:#1a7f37,stroke-width:3px', ' class n1 added', ' classDef modified stroke:#bc4c00,stroke-width:3px', ' class n3 modified',
|
||||
' classDef removed stroke:#cf222e,stroke-width:2px,stroke-dasharray:5 4', ' class n2 removed', '```'].join('\n'));
|
||||
assert.ok(body.indexOf('<summary>🟧 Modified') < body.indexOf('<summary>Map') && body.indexOf('<summary>Map') < body.indexOf('<summary>Validation'));
|
||||
assert.match(body, /<summary>Map \(4 screens\)<\/summary>\n\n```mermaid\n/, 'a blank line opens the fence inside the collapsible');
|
||||
assert.deepEqual(readCommentRecords(body).current.ios.navigation, platformRecordOf(state({ map: true, review: withNavigation })).navigation, 'the map is carried in the record');
|
||||
|
||||
// A label cannot end itself, its line or the fence.
|
||||
const odd = { ...withNavigation, surfaces: withNavigation.surfaces.map(entry => entry.id === 'care-guide'
|
||||
? { ...entry, head: { ...entry.head, logicalPath: 'cats/"a"#<b>`c`' } } : entry) };
|
||||
assert.match(renderPublicComment(state({ map: true, review: odd })), /\n {2}n1\["\/cats\/#quot;a#quot;#35;#lt;b#gt;#96;c#96;"\]\n/);
|
||||
// No navigation, or nothing changed visually: no map.
|
||||
assert.ok(!summaries(renderPublicComment(state({ map: true }))).includes('Map (4 screens)'));
|
||||
const unchanged = { ...withNavigation, surfaces: withNavigation.surfaces.filter(entry => entry.status !== 'added' && entry.status !== 'removed' && !entry.id.startsWith('settings')) };
|
||||
assert.ok(!/<summary>Map/.test(renderPublicComment(state({ map: true, review: unchanged }))));
|
||||
});
|
||||
|
||||
test('the map is dropped before the change lists shrink, and a malformed map is dropped from the record', async () => {
|
||||
const { encodeRecordPayload } = await import('../../dist/report/pr-comment-record.js');
|
||||
const { readCommentRecords, renderCommentRecords } = await import('../../dist/report/pr-comment-body.js');
|
||||
const record = { ...platformRecordOf(state()), navigation: { nodes: [{ route: '/a', group: 'modified' }, { route: '/b' }], edges: [{ from: 1, to: 0, kinds: ['push'] }] } };
|
||||
const records = { current: { ios: record }, history: [] };
|
||||
assert.match(renderCommentRecords(records), /<summary>Map \(2 screens\)<\/summary>/);
|
||||
const tight = renderCommentRecords(records, undefined, renderCommentRecords(records).length - 1);
|
||||
assert.ok(!tight.includes('```mermaid'));
|
||||
assert.match(tight, /<summary>🟧 Modified \(1\)<\/summary>/);
|
||||
const parse = navigation => readCommentRecords(`<!-- expo-explore-record:ios:${encodeRecordPayload({ ...record, navigation })} -->`).current.ios;
|
||||
assert.deepEqual(parse(record.navigation).navigation, record.navigation);
|
||||
for (const navigation of [{ ...record.navigation, edges: [{ from: 0, to: 2, kinds: ['push'] }] }, { ...record.navigation, edges: [{ from: 0, to: 1, kinds: ['teleport'] }] },
|
||||
{ ...record.navigation, nodes: [{ route: '/a', group: 'needs-review' }, { route: '/b' }] }, { nodes: [], edges: [] }]) {
|
||||
const parsed = parse(navigation);
|
||||
assert.ok(parsed, 'the rest of the record still parses');
|
||||
assert.equal(parsed.navigation, undefined);
|
||||
}
|
||||
});
|
||||
@@ -306,6 +306,8 @@ function ViewerApp() {
|
||||
const [mapProjectionFitKey, setMapProjectionFitKey] = useState(0);
|
||||
// A report captured in several appearances shows one at a time; the primary (first captured) is the default.
|
||||
const [appearanceChoice, setAppearanceChoice] = useState<Appearance | undefined>();
|
||||
// For the ⇧T shortcut, which steps to the next captured appearance; set once they are known.
|
||||
const appearanceRef = useRef<{ options: readonly Appearance[]; current: Appearance | undefined }>({ options: [], current: undefined });
|
||||
const [handoffOpen, setHandoffOpen] = useState(false);
|
||||
/** Whether this page can hand the report off (a hosted preview); the A key reads it. */
|
||||
const handoffAvailableRef = useRef(false);
|
||||
@@ -371,6 +373,10 @@ function ViewerApp() {
|
||||
const toggleTheme = useCallback(() => {
|
||||
setThemePreference(current => current === "system" ? "dark" : current === "dark" ? "light" : "system");
|
||||
}, []);
|
||||
// The T key flips what is on screen, dark to light and back; only the button returns to Auto.
|
||||
const flipTheme = useCallback(() => {
|
||||
setThemePreference(current => (current === "system" ? preferredSystemTheme : current) === "dark" ? "light" : "dark");
|
||||
}, [preferredSystemTheme]);
|
||||
|
||||
const load = useCallback(async (silent = false) => {
|
||||
void silent;
|
||||
@@ -994,6 +1000,14 @@ function ViewerApp() {
|
||||
if (matchesShortcut(event, SHORTCUTS.app.handoff)) {
|
||||
if (!handoffAvailableRef.current) return;
|
||||
setHandoffOpen(true);
|
||||
} else if (matchesShortcut(event, SHORTCUTS.appearance.theme)) {
|
||||
flipTheme();
|
||||
} else if (matchesShortcut(event, SHORTCUTS.appearance.app)) {
|
||||
// Only a report captured in both schemes has another appearance to show.
|
||||
const { options, current } = appearanceRef.current;
|
||||
if (options.length < 2) return;
|
||||
const index = current ? options.indexOf(current) : -1;
|
||||
setAppearanceChoice(options[(index + 1) % options.length]);
|
||||
} else if (matchesShortcut(event, SHORTCUTS.app.changes)) {
|
||||
setChangesOpen((open) => !open);
|
||||
} else if (matchesShortcut(event, SHORTCUTS.panel.right)) {
|
||||
@@ -1009,7 +1023,7 @@ function ViewerApp() {
|
||||
return () => {
|
||||
window.removeEventListener("keydown", onKeyDown);
|
||||
};
|
||||
}, [clearSelectedScreen, navigate, searchOpen, selectCanvas, toggleRightPanel]);
|
||||
}, [clearSelectedScreen, flipTheme, navigate, searchOpen, selectCanvas, toggleRightPanel]);
|
||||
|
||||
// A side-panel row or a deep link is a "go to": the camera fits that screen and the step is
|
||||
// kept. Screens inventory clicks only select in place; Map clicks also focus the chosen screen. Repeating a selected target refits it without adding history.
|
||||
@@ -1102,6 +1116,7 @@ function ViewerApp() {
|
||||
const baseline = builds.find((build) => build.id === route.baseline);
|
||||
const appearances = useMemo(() => appearanceOptions(payload?.map), [payload]);
|
||||
const appearance = appearanceChoice && appearances.includes(appearanceChoice) ? appearanceChoice : appearances[0];
|
||||
appearanceRef.current = { options: appearances, current: appearance };
|
||||
const appearanceMap = useMemo(() => payload ? filterMapAppearance(payload.map, appearance) : undefined, [appearance, payload]);
|
||||
const currentMap = useMemo(() => (
|
||||
appearanceMap && workspace && currentBuild
|
||||
@@ -1605,7 +1620,6 @@ function ViewerApp() {
|
||||
) : <CanvasToolbar
|
||||
canvas={route.canvas}
|
||||
searchOpen={searchOpen}
|
||||
compareCount={compareOrder.length}
|
||||
{...(handoffAction ? { actions: handoffAction } : {})}
|
||||
onOpenShortcuts={() => setShortcutsOpen(true)}
|
||||
onSelectCanvas={selectCanvas}
|
||||
@@ -1614,7 +1628,7 @@ function ViewerApp() {
|
||||
</CanvasVisibleFrameProvider>
|
||||
{shortcutsOpen ? (
|
||||
<ShortcutsDialog
|
||||
context={{ canvas: route.canvas, review: reviewingInSidebar, hasChanges: compareOrder.length > 0, handoff: Boolean(handoffInput) }}
|
||||
context={{ canvas: route.canvas, review: reviewingInSidebar, hasChanges: compareOrder.length > 0, handoff: Boolean(handoffInput), appearances: appearances.length > 1 }}
|
||||
onClose={() => setShortcutsOpen(false)}
|
||||
/>
|
||||
) : null}
|
||||
|
||||
@@ -3,6 +3,7 @@ import { Fullscreen, LocateFixed } from "lucide-react";
|
||||
import { runCanvasZoomCommand } from "../../utils/canvas-zoom";
|
||||
import { useCanvasZoom } from "../../hooks/use-canvas-zoom";
|
||||
import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
|
||||
import { KeyHint } from "../shared/key-hint";
|
||||
import { Menu, type MenuItem } from "../shared/menu";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { FullscreenToggleButton, ThemeToggleButton, type ShellActionsProps, type ShellTheme } from "../panels/shell-actions";
|
||||
@@ -86,6 +87,7 @@ function FitControl() {
|
||||
disabled={!camera}
|
||||
onClick={() => runCanvasZoomCommand(camera?.hasSelection() ? "selection" : "fit")}>
|
||||
<Fullscreen aria-hidden="true" />
|
||||
<KeyHint shortcut={SHORTCUTS.camera.fit} />
|
||||
</button>
|
||||
</Tooltip>
|
||||
);
|
||||
@@ -105,6 +107,7 @@ function RecenterControl() {
|
||||
disabled={!camera}
|
||||
onClick={() => runCanvasZoomCommand("recenter")}>
|
||||
<LocateFixed aria-hidden="true" />
|
||||
<KeyHint shortcut={SHORTCUTS.camera.center} />
|
||||
</button>
|
||||
</Tooltip>
|
||||
);
|
||||
|
||||
@@ -2,7 +2,8 @@ import { GitCompareArrows, Keyboard, LayoutGrid, Map, Search } from "lucide-reac
|
||||
import { type CSSProperties } from "react";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { useCanvasVisibleFrame } from "./visible-frame-provider";
|
||||
import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
|
||||
import { CANVAS_NUMBER_KEYS, formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
|
||||
import { KeyHint } from "../shared/key-hint";
|
||||
import {
|
||||
CANVAS_DESCRIPTIONS,
|
||||
CANVAS_LABELS,
|
||||
@@ -21,9 +22,6 @@ const TOOLBAR_MINIMUM_FRAME_WIDTH = 220;
|
||||
type CanvasToolbarProps = {
|
||||
canvas: CanvasView;
|
||||
searchOpen: boolean;
|
||||
/** How many changed screens Compare holds, shown as a badge on its button. Compare's own header
|
||||
steps through them. */
|
||||
compareCount?: number;
|
||||
/** Page-wide actions beside Search (Hand off to AI). */
|
||||
actions?: React.ReactNode;
|
||||
onSelectCanvas: (canvas: CanvasView) => void;
|
||||
@@ -60,6 +58,7 @@ export function CanvasToolbar(props: CanvasToolbarProps) {
|
||||
aria-expanded={props.searchOpen}
|
||||
onClick={props.onOpenSearch}>
|
||||
<Search />
|
||||
<KeyHint shortcut={SHORTCUTS.app.search} />
|
||||
</button>
|
||||
</Tooltip>
|
||||
{props.actions}
|
||||
@@ -88,9 +87,7 @@ export function CanvasToolbar(props: CanvasToolbarProps) {
|
||||
onClick={() => props.onSelectCanvas(id)}>
|
||||
{VIEW_ICONS[id]}
|
||||
<span className="toolbar-view-label" aria-hidden="true"><span>{CANVAS_LABELS[id]}</span></span>
|
||||
{id === "compare" && props.compareCount ? (
|
||||
<span className="toolbar-badge" aria-hidden="true">{props.compareCount}</span>
|
||||
) : null}
|
||||
{CANVAS_NUMBER_KEYS ? <KeyHint shortcut={SHORTCUTS.canvasByNumber[id]} /> : null}
|
||||
</button>
|
||||
</Tooltip>
|
||||
);
|
||||
|
||||
@@ -3,6 +3,7 @@ import { useReactFlow, useStore } from "@xyflow/react";
|
||||
import { publishZoom, registerZoomApi, runCanvasZoomCommand } from "../../utils/canvas-zoom";
|
||||
import { isTyping, matchesShortcut, SHORTCUTS } from "../../utils/shortcuts";
|
||||
import { useCanvasVisibleFrame } from "./visible-frame-provider";
|
||||
import { createKeyHold, glideWhileHeld, type KeyHold } from "../../utils/key-hold";
|
||||
import {
|
||||
canvasBoundsViewport,
|
||||
canvasPriorityProjectionBounds,
|
||||
@@ -15,6 +16,8 @@ import {
|
||||
} from "./camera";
|
||||
|
||||
const DURATION = 160;
|
||||
/** React Flow's zoomIn/zoomOut step, which a tap of + or − takes. */
|
||||
const KEY_ZOOM_STEP = 1.2;
|
||||
const PIXEL_WHEEL_ZOOM_RATE = 0.002;
|
||||
const LINE_WHEEL_ZOOM_RATE = 0.05;
|
||||
const PAGE_WHEEL_ZOOM_RATE = 1;
|
||||
@@ -36,6 +39,12 @@ function canvasOwnsKeyboardEvent(event: KeyboardEvent, canvas: HTMLElement): boo
|
||||
return focusOwned || canvas.matches(":hover");
|
||||
}
|
||||
|
||||
function plainZoomDirection(event: KeyboardEvent): 1 | -1 | undefined {
|
||||
if (event.key === "+" || event.key === "=") return 1;
|
||||
if (event.key === "-" || event.key === "_") return -1;
|
||||
return undefined;
|
||||
}
|
||||
|
||||
function modifiedZoomCommand(event: KeyboardEvent): "in" | "out" | "100" | undefined {
|
||||
if (event.code === "Equal" || event.code === "NumpadAdd") return "in";
|
||||
if (event.code === "Minus" || event.code === "NumpadSubtract") return "out";
|
||||
@@ -60,6 +69,12 @@ export function ZoomBridge(props: {
|
||||
fitMaxZoom?: number;
|
||||
}) {
|
||||
const { visibleFrame } = useCanvasVisibleFrame();
|
||||
// Outlives the effect below, which re-runs as the camera moves: a held key must not end just
|
||||
// because its own zoom step re-registered the listeners.
|
||||
const holdRef = useRef<KeyHold>(undefined);
|
||||
holdRef.current ??= createKeyHold();
|
||||
const hold = holdRef.current;
|
||||
useEffect(() => () => hold.end(), [hold]);
|
||||
const {
|
||||
zoomIn,
|
||||
zoomOut,
|
||||
@@ -201,8 +216,37 @@ export function ZoomBridge(props: {
|
||||
};
|
||||
registerZoomApi(api);
|
||||
|
||||
// A tap of + or − takes one eased step. Held, the OS key repeat is ignored (each repeat
|
||||
// restarting the easing made holding slower than tapping); once the tap's step has landed the
|
||||
// camera glides instead, frame by frame about the pane's centre, as zoomIn does, until the key
|
||||
// is released, the hold is interrupted, or the zoom reaches its limit.
|
||||
const zoomStep = (direction: 1 | -1): boolean => {
|
||||
const viewport = getViewport();
|
||||
const next = Math.min(maxZoom, Math.max(minZoom, viewport.zoom * KEY_ZOOM_STEP ** direction));
|
||||
if (next === viewport.zoom) return false;
|
||||
if (direction === 1) void zoomIn({ duration: DURATION });
|
||||
else void zoomOut({ duration: DURATION });
|
||||
return true;
|
||||
};
|
||||
const zoomGlide = (direction: 1 | -1) => (steps: number): boolean => {
|
||||
const viewport = getViewport();
|
||||
const zoom = Math.min(maxZoom, Math.max(minZoom, viewport.zoom * KEY_ZOOM_STEP ** (direction * steps)));
|
||||
if (zoom === viewport.zoom) return false;
|
||||
const scale = zoom / viewport.zoom;
|
||||
const centerX = canvasWidth / 2;
|
||||
const centerY = canvasHeight / 2;
|
||||
void setViewport({ zoom, x: centerX - (centerX - viewport.x) * scale, y: centerY - (centerY - viewport.y) * scale });
|
||||
return true;
|
||||
};
|
||||
|
||||
const onKeyDown = (event: KeyboardEvent) => {
|
||||
hold.interrupt(event);
|
||||
// Typing comes first: a held key's repeats belong to a field that took focus mid-hold.
|
||||
if (isTyping(event.target)) return;
|
||||
if (event.repeat && hold.holding(event.code)) {
|
||||
event.preventDefault();
|
||||
return;
|
||||
}
|
||||
|
||||
// Browser zoom and canvas zoom use the same familiar chord. The pointer/focus boundary
|
||||
// decides who owns it: canvas-owned events reset its camera; a focused panel or field keeps
|
||||
@@ -225,10 +269,18 @@ export function ZoomBridge(props: {
|
||||
event.preventDefault();
|
||||
return;
|
||||
}
|
||||
if (event.key === "+" || event.key === "=") runCanvasZoomCommand("in");
|
||||
else if (event.key === "-" || event.key === "_") runCanvasZoomCommand("out");
|
||||
else return;
|
||||
const direction = plainZoomDirection(event);
|
||||
if (!direction) return;
|
||||
event.preventDefault();
|
||||
onCameraGestureStart.current?.();
|
||||
if (!zoomStep(direction)) return;
|
||||
// The hold only tracks the key (released, interrupted, a field or dialog taking over); the
|
||||
// glide reads it every frame and stops with it.
|
||||
hold.begin(event.code, () => true);
|
||||
glideWhileHeld(hold, event.code, DURATION, zoomGlide(direction));
|
||||
};
|
||||
const onKeyUp = (event: KeyboardEvent) => {
|
||||
if (hold.holding(event.code)) hold.end();
|
||||
};
|
||||
|
||||
const onModifierWheel = (event: WheelEvent) => {
|
||||
@@ -292,9 +344,13 @@ export function ZoomBridge(props: {
|
||||
};
|
||||
|
||||
window.addEventListener("keydown", onKeyDown);
|
||||
window.addEventListener("keyup", onKeyUp);
|
||||
window.addEventListener("blur", hold.end);
|
||||
canvas?.addEventListener("wheel", onModifierWheel, { capture: true, passive: false });
|
||||
return () => {
|
||||
window.removeEventListener("keydown", onKeyDown);
|
||||
window.removeEventListener("keyup", onKeyUp);
|
||||
window.removeEventListener("blur", hold.end);
|
||||
canvas?.removeEventListener("wheel", onModifierWheel, { capture: true });
|
||||
if (wheelFrame.current !== undefined) cancelAnimationFrame(wheelFrame.current);
|
||||
wheelFrame.current = undefined;
|
||||
@@ -308,6 +364,7 @@ export function ZoomBridge(props: {
|
||||
getNodes,
|
||||
getNodesBounds,
|
||||
getViewport,
|
||||
hold,
|
||||
maxZoom,
|
||||
minZoom,
|
||||
props.fitPadding,
|
||||
|
||||
@@ -5,6 +5,7 @@ import { StatusGlyph } from "../shared/status-icon";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { DIFF_LABELS, type DiffStatus } from "../../utils/build-diff";
|
||||
import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
|
||||
import { KeyHint } from "../shared/key-hint";
|
||||
import { setMeasurementsShown, useMeasurementsShown } from "../../utils/measurements-setting";
|
||||
|
||||
/** A screen whose every changed area only moved: how far, per direction, and whether no other finding remains. */
|
||||
@@ -48,6 +49,7 @@ export function CompareNav(props: {
|
||||
<StatusGlyph status={props.status} accessibilityOnly={props.accessibilityOnly} label={props.statusLabel ?? DIFF_LABELS[props.status]} />
|
||||
{/* A route that does not fit loses its start, not the end that names the screen. */}
|
||||
<code className="compare-nav-route" title={props.title}><bdi>{props.route}</bdi></code>
|
||||
<KeyHint shortcut={SHORTCUTS.app.changes} />
|
||||
</button>
|
||||
</Tooltip>
|
||||
{props.stepsApart ? null : <CompareSteps {...props} />}
|
||||
|
||||
@@ -6,7 +6,7 @@ import type { MapIndex } from "../../utils/model";
|
||||
import type { ChangedScreen } from "../../utils/changed-screens";
|
||||
import { groupVisualRegions, layoutShiftSummary, type VisualChange } from "../../utils/visual-diff";
|
||||
import { formatShortcut, matchesShortcut, SHORTCUTS, shortcutsLive } from "../../utils/shortcuts";
|
||||
import { HOLD_INITIAL_DELAY_MS, holdIntervalMs } from "../../utils/key-hold";
|
||||
import { createKeyHold, glideWhileHeld, HOLD_INITIAL_DELAY_MS, type KeyHold } from "../../utils/key-hold";
|
||||
import { optionalStorage } from "../../utils/embedded-report";
|
||||
import { usePhoneLayout } from "../../utils/phone-layout";
|
||||
import { ToggleGroup } from "../shared/toggle-group";
|
||||
@@ -160,11 +160,12 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
};
|
||||
const flip = () => setFlipSide((side) => (side === "after" ? "before" : "after"));
|
||||
|
||||
const keyState = useRef({ previous, next, mode, activeArea, options });
|
||||
keyState.current = { previous, next, mode, activeArea, options };
|
||||
const keyState = useRef({ previous, next, mode, activeArea, options, swipePosition });
|
||||
keyState.current = { previous, next, mode, activeArea, options, swipePosition };
|
||||
|
||||
// Stepping to the previous or next changed screen; a held key keeps stepping, accelerating, until
|
||||
// it is released, the window loses focus, or the list ends. Reads the latest neighbours on each step.
|
||||
// it is released, the window loses focus, or the end is reached. The Swipe divider is continuous,
|
||||
// so a tap of [ or ] nudges it one step and a held one glides. Both read the latest state.
|
||||
const stepScreen = (direction: 1 | -1): boolean => {
|
||||
const state = keyState.current;
|
||||
const target = direction === 1 ? state.next : state.previous;
|
||||
@@ -172,34 +173,38 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
state.options.onSelectScreen(target.id);
|
||||
return true;
|
||||
};
|
||||
const hold = useRef<{ code: string; timer: ReturnType<typeof setTimeout> } | undefined>(undefined);
|
||||
const endHold = () => {
|
||||
if (!hold.current) return;
|
||||
clearTimeout(hold.current.timer);
|
||||
hold.current = undefined;
|
||||
const moveDivider = (direction: 1 | -1, steps = 1): boolean => {
|
||||
const state = keyState.current;
|
||||
if (state.mode !== "swipe") return false;
|
||||
const position = Math.max(0, Math.min(100, state.swipePosition + direction * SWIPE_STEP * steps));
|
||||
if (position === state.swipePosition) return false;
|
||||
state.swipePosition = position;
|
||||
setSwipePosition(position);
|
||||
return true;
|
||||
};
|
||||
const beginHold = (code: string, direction: 1 | -1) => {
|
||||
endHold();
|
||||
let step = 1;
|
||||
const tick = () => {
|
||||
if (!stepScreen(direction)) { endHold(); return; }
|
||||
hold.current = { code, timer: setTimeout(tick, holdIntervalMs(step)) };
|
||||
step += 1;
|
||||
};
|
||||
hold.current = { code, timer: setTimeout(tick, HOLD_INITIAL_DELAY_MS) };
|
||||
const holdRef = useRef<KeyHold>(undefined);
|
||||
holdRef.current ??= createKeyHold();
|
||||
const hold = holdRef.current;
|
||||
useEffect(() => hold.end, [hold]);
|
||||
// The hold only tracks the key; the glide reads it every frame and stops with it.
|
||||
const glideDivider = (code: string, direction: 1 | -1) => {
|
||||
hold.begin(code, () => true);
|
||||
glideWhileHeld(hold, code, HOLD_INITIAL_DELAY_MS, (steps) => moveDivider(direction, steps));
|
||||
};
|
||||
useEffect(() => endHold, []);
|
||||
|
||||
useEffect(() => {
|
||||
const onKeyDown = (event: KeyboardEvent) => {
|
||||
hold.interrupt(event);
|
||||
// The browser's own repeat of the held key is not a step; it must not scroll either.
|
||||
if (event.repeat && hold.holding(event.code)) { event.preventDefault(); return; }
|
||||
if (event.defaultPrevented || !shortcutsLive(event)) return;
|
||||
const state = keyState.current;
|
||||
const keys = SHORTCUTS.compare;
|
||||
const stepScreens = state.options.stepScreens !== false;
|
||||
if (stepScreens && matchesShortcut(event, keys.previousScreen)) {
|
||||
if (stepScreen(-1)) beginHold(event.code, -1);
|
||||
if (stepScreen(-1)) hold.begin(event.code, () => stepScreen(-1));
|
||||
} else if (stepScreens && matchesShortcut(event, keys.nextScreen)) {
|
||||
if (stepScreen(1)) beginHold(event.code, 1);
|
||||
if (stepScreen(1)) hold.begin(event.code, () => stepScreen(1));
|
||||
} else if (matchesShortcut(event, keys.nextArea)) {
|
||||
stepArea(1);
|
||||
} else if (matchesShortcut(event, keys.previousArea)) {
|
||||
@@ -220,10 +225,10 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
flip();
|
||||
} else if (matchesShortcut(event, keys.dividerLeft)) {
|
||||
if (state.mode !== "swipe") return;
|
||||
setSwipePosition((value) => Math.max(0, value - SWIPE_STEP));
|
||||
if (moveDivider(-1)) glideDivider(event.code, -1);
|
||||
} else if (matchesShortcut(event, keys.dividerRight)) {
|
||||
if (state.mode !== "swipe") return;
|
||||
setSwipePosition((value) => Math.min(100, value + SWIPE_STEP));
|
||||
if (moveDivider(1)) glideDivider(event.code, 1);
|
||||
} else if (matchesShortcut(event, keys.outlines)) {
|
||||
toggleOutlines();
|
||||
} else if (matchesShortcut(event, keys.whatChanged)) {
|
||||
@@ -234,15 +239,15 @@ export function useCompareController(options: CompareControllerOptions) {
|
||||
event.preventDefault();
|
||||
};
|
||||
const onKeyUp = (event: KeyboardEvent) => {
|
||||
if (hold.current && event.code === hold.current.code) endHold();
|
||||
if (hold.holding(event.code)) hold.end();
|
||||
};
|
||||
window.addEventListener("keydown", onKeyDown);
|
||||
window.addEventListener("keyup", onKeyUp);
|
||||
window.addEventListener("blur", endHold);
|
||||
window.addEventListener("blur", hold.end);
|
||||
return () => {
|
||||
window.removeEventListener("keydown", onKeyDown);
|
||||
window.removeEventListener("keyup", onKeyUp);
|
||||
window.removeEventListener("blur", endHold);
|
||||
window.removeEventListener("blur", hold.end);
|
||||
};
|
||||
});
|
||||
|
||||
|
||||
@@ -17,6 +17,8 @@ export type ShortcutContext = {
|
||||
hasChanges: boolean;
|
||||
/** The report can be handed off to an agent (a hosted preview). */
|
||||
handoff?: boolean;
|
||||
/** The report was captured in both light and dark, so the app's appearance can be switched. */
|
||||
appearances?: boolean;
|
||||
};
|
||||
|
||||
const COMPARE = SHORTCUTS.compare;
|
||||
@@ -75,13 +77,15 @@ export function shortcutGroups(context: ShortcutContext): Group[][] {
|
||||
title: "View",
|
||||
rows: [
|
||||
...(context.canvas === "compare" ? [] : [{ label: "Show or hide the inspector", keys: [SHORTCUTS.panel.right] }]),
|
||||
{ label: "Viewer theme: dark or light", keys: [SHORTCUTS.appearance.theme] },
|
||||
...(context.appearances ? [{ label: "The app's appearance: light or dark", keys: [SHORTCUTS.appearance.app] }] : []),
|
||||
{ label: "Show this list", keys: ["?"] },
|
||||
],
|
||||
};
|
||||
const mapGroup: Group = {
|
||||
title: "Map",
|
||||
rows: [
|
||||
{ label: "Walk the map from the selected screen", keys: ["↑", "↓", "←", "→", "H J K L"] },
|
||||
{ label: "Walk the map, or enter it at an edge", keys: ["↑", "↓", "←", "→", "H J K L"] },
|
||||
{ label: "Undo or redo moving a card", keys: [SHORTCUTS.edit.undo, SHORTCUTS.edit.redo] },
|
||||
{ label: "Close the inspector, then deselect", keys: ["Esc"] },
|
||||
],
|
||||
|
||||
@@ -7,6 +7,8 @@ import { isPreviewPath, isReportTargetId, previewReportsUrl, targetQuery } from
|
||||
import { ScreenshotImage } from "../shared/screenshot-image";
|
||||
import { artifactUrl } from "../../utils/model";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { KeyHint } from "../shared/key-hint";
|
||||
import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
|
||||
import { ChangesMenu } from "./changes-menu";
|
||||
import type { FocusStatus } from "../../utils/navigation";
|
||||
import type { ExploreMap, MapIndex } from "../../utils/model";
|
||||
@@ -192,12 +194,13 @@ export function AppPill(props: AppPillProps) {
|
||||
) : null}
|
||||
{props.appearance ? (
|
||||
<>
|
||||
<Tooltip label="Appearance · the same screens captured in the other scheme" placement="bottom">
|
||||
<Tooltip label="Appearance · the same screens captured in the other scheme" shortcut={formatShortcut(SHORTCUTS.appearance.app)} placement="bottom">
|
||||
<button ref={appearanceRef} type="button" className="collapsed-platform" aria-haspopup="menu" aria-expanded={appearanceOpen}
|
||||
aria-label={`Appearance: ${appearanceLabel(props.appearance.current)}. Show the other appearance`}
|
||||
onClick={() => setAppearanceOpen(open => !open)}>
|
||||
{appearanceLabel(props.appearance.current)}
|
||||
<svg aria-hidden="true" width="8" height="8" viewBox="0 0 8 8"><path d="M1 2.5 4 5.5 7 2.5" fill="none" stroke="currentColor" strokeWidth="1.5" strokeLinecap="round" strokeLinejoin="round" /></svg>
|
||||
<KeyHint shortcut={SHORTCUTS.appearance.app} />
|
||||
</button>
|
||||
</Tooltip>
|
||||
<Menu items={appearanceItems} open={appearanceOpen} anchorRef={appearanceRef} ariaLabel="Appearance" onDismiss={() => setAppearanceOpen(false)} />
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
import { useEffect, useState } from "react";
|
||||
import { Maximize, Minimize, Moon, Sun, SunMoon } from "lucide-react";
|
||||
import { Tooltip } from "../shared/tooltip";
|
||||
import { formatShortcut, SHORTCUTS } from "../../utils/shortcuts";
|
||||
import type { ThemePreference } from "../../utils/navigation";
|
||||
|
||||
export type ShellTheme = "light" | "dark";
|
||||
@@ -51,7 +52,7 @@ const THEME_LABELS: Record<ThemePreference, string> = {
|
||||
export function ThemeToggleButton(props: ShellActionsProps) {
|
||||
const Icon = props.themePreference === "system" ? SunMoon : props.themePreference === "dark" ? Moon : Sun;
|
||||
return (
|
||||
<Tooltip label={THEME_LABELS[props.themePreference]} placement="bottom">
|
||||
<Tooltip label={THEME_LABELS[props.themePreference]} shortcut={formatShortcut(SHORTCUTS.appearance.theme)} placement="bottom">
|
||||
<button
|
||||
type="button"
|
||||
className={props.className ?? "icon-button"}
|
||||
|
||||
@@ -0,0 +1,14 @@
|
||||
import { heldKeyHint, useHeldModifiers } from "../../utils/held-modifiers";
|
||||
import type { Shortcut } from "../../utils/shortcuts";
|
||||
|
||||
/**
|
||||
* The key that completes a chord, shown on a button's corner while the chord's modifiers are
|
||||
* held. Hold ⌃ and the toolbar's sections show 1, 2 and 3; release it and they are gone.
|
||||
* Nothing renders for a plain key or while nothing is held.
|
||||
*/
|
||||
export function KeyHint({ shortcut }: { shortcut: Shortcut }) {
|
||||
const held = useHeldModifiers();
|
||||
const key = heldKeyHint(shortcut, held);
|
||||
if (!key) return null;
|
||||
return <kbd className="key-hint" aria-hidden="true">{key}</kbd>;
|
||||
}
|
||||
@@ -9,7 +9,7 @@ import { screenTree, treeIndex, treeNodeKey, treeScreenOrder, type ScreenTree, t
|
||||
import type { Appearance } from "../../utils/appearance";
|
||||
import type { FocusRequest, FocusStatus } from "../../utils/navigation";
|
||||
import { shortcutsLive } from "../../utils/shortcuts";
|
||||
import { HOLD_INITIAL_DELAY_MS, holdIntervalMs } from "../../utils/key-hold";
|
||||
import { createKeyHold } from "../../utils/key-hold";
|
||||
import { placeholderScreen } from "../../utils/map-frame";
|
||||
import { ScreenScreenshotCard } from "../canvas/screen-screenshot-card";
|
||||
import { useCanvasVisibleFrame } from "../canvas/visible-frame-provider";
|
||||
@@ -393,28 +393,23 @@ export function ScreensView(props: ScreensViewProps) {
|
||||
pickRef.current(id);
|
||||
requestAnimationFrame(() => document.getElementById(cardId(id))?.querySelector<HTMLElement>(".screen-screenshot-target")?.focus({ preventScroll: true }));
|
||||
};
|
||||
let hold: { code: string; at: string; timer: ReturnType<typeof setTimeout> } | undefined;
|
||||
const endHold = () => {
|
||||
if (hold) clearTimeout(hold.timer);
|
||||
hold = undefined;
|
||||
};
|
||||
// A held arrow keeps stepping from the card the last step landed on, not the lagging pick.
|
||||
const hold = createKeyHold();
|
||||
const beginHold = (code: string, at: string) => {
|
||||
endHold();
|
||||
let step = 1;
|
||||
const tick = () => {
|
||||
const id = hold && next(code, hold.at);
|
||||
if (!hold || !id) { endHold(); return; }
|
||||
hold.begin(code, () => {
|
||||
const id = next(code, at);
|
||||
if (!id) return false;
|
||||
at = id;
|
||||
go(id);
|
||||
hold = { code, at: id, timer: setTimeout(tick, holdIntervalMs(step)) };
|
||||
step += 1;
|
||||
};
|
||||
hold = { code, at, timer: setTimeout(tick, HOLD_INITIAL_DELAY_MS) };
|
||||
return true;
|
||||
});
|
||||
};
|
||||
const onKeyDown = (event: globalThis.KeyboardEvent) => {
|
||||
hold.interrupt(event);
|
||||
const arrow = ["ArrowLeft", "ArrowRight", "ArrowUp", "ArrowDown"].includes(event.code);
|
||||
if (!arrow && event.key !== "Enter") return;
|
||||
// The browser's own repeat of a held arrow would scroll the page under the hold.
|
||||
if (event.repeat && hold?.code === event.code) { event.preventDefault(); return; }
|
||||
if (event.repeat && hold.holding(event.code)) { event.preventDefault(); return; }
|
||||
if (event.metaKey || event.ctrlKey || event.altKey || event.shiftKey || event.defaultPrevented || !shortcutsLive(event)) return;
|
||||
const target = event.target instanceof Element ? event.target : null;
|
||||
if (!arrow) {
|
||||
@@ -436,8 +431,9 @@ export function ScreensView(props: ScreensViewProps) {
|
||||
beginHold(event.code, id);
|
||||
};
|
||||
const onKeyUp = (event: globalThis.KeyboardEvent) => {
|
||||
if (hold && event.code === hold.code) endHold();
|
||||
if (hold.holding(event.code)) hold.end();
|
||||
};
|
||||
const endHold = hold.end;
|
||||
window.addEventListener("keydown", onKeyDown);
|
||||
window.addEventListener("keyup", onKeyUp);
|
||||
window.addEventListener("blur", endHold);
|
||||
|
||||
@@ -27,7 +27,8 @@ import type { FocusBehavior, FocusRequest, FocusStatus, MapDirection } from "../
|
||||
import { focusStatusOf } from "../../utils/changed-screens";
|
||||
import { displayPathForScreen } from "../../utils/screen-path";
|
||||
import { shortcutsLive } from "../../utils/shortcuts";
|
||||
import { mapKeyDirection, mapKeyTarget } from "../../utils/map-keyboard";
|
||||
import { arrowsOwnedBy, mapKeyDirection, mapKeyEntry, mapKeyTarget, type MapKeyDirection } from "../../utils/map-keyboard";
|
||||
import { createKeyHold } from "../../utils/key-hold";
|
||||
|
||||
const HOVER_CLEAR_DELAY = 180;
|
||||
const MAP_LAYOUT_REVISION = "flat-v1";
|
||||
@@ -552,24 +553,51 @@ function ConnectionCanvas(props: MapViewProps) {
|
||||
if (hoverClearTimer.current !== undefined) window.clearTimeout(hoverClearTimer.current);
|
||||
applyHover(undefined);
|
||||
}, [applyHover]);
|
||||
// With a screen selected, the arrow keys (or h j k l) walk the map: along an edge in the
|
||||
// layout's flow, across to the neighbour on the same rank otherwise.
|
||||
// The arrow keys (or h j k l) walk the map from the selected screen: along an edge in the
|
||||
// layout's flow, across to the neighbour on the same rank otherwise. With nothing selected they
|
||||
// enter the map at its edge, as on the Screens page. A held key keeps walking.
|
||||
const { selectedScreenId } = props;
|
||||
const selectedRef = useRef(selectedScreenId);
|
||||
selectedRef.current = selectedScreenId;
|
||||
useEffect(() => {
|
||||
if (!selectedScreenId) return;
|
||||
const hold = createKeyHold();
|
||||
const move = (direction: MapKeyDirection, from: string | undefined): string | undefined => {
|
||||
const structure = structureRef.current;
|
||||
if (!structure) return undefined;
|
||||
return from ? mapKeyTarget(structure, from, direction) : mapKeyEntry(structure, direction);
|
||||
};
|
||||
const onKeyDown = (event: KeyboardEvent) => {
|
||||
if (event.defaultPrevented || !shortcutsLive(event)) return;
|
||||
hold.interrupt(event);
|
||||
if (event.repeat && hold.holding(event.code)) { event.preventDefault(); return; }
|
||||
if (event.defaultPrevented || !shortcutsLive(event) || arrowsOwnedBy(event.target)) return;
|
||||
const direction = mapKeyDirection(event);
|
||||
if (!direction) return;
|
||||
const structure = structureRef.current;
|
||||
if (!structure) return;
|
||||
if (!structureRef.current) return;
|
||||
event.preventDefault();
|
||||
const target = mapKeyTarget(structure, selectedScreenId, direction);
|
||||
if (target) selectScreen(target);
|
||||
let at = move(direction, selectedRef.current);
|
||||
if (!at) return;
|
||||
selectScreen(at);
|
||||
hold.begin(event.code, () => {
|
||||
const target = move(direction, at);
|
||||
if (!target) return false;
|
||||
at = target;
|
||||
selectScreen(target);
|
||||
return true;
|
||||
});
|
||||
};
|
||||
const onKeyUp = (event: KeyboardEvent) => {
|
||||
if (hold.holding(event.code)) hold.end();
|
||||
};
|
||||
window.addEventListener("keydown", onKeyDown);
|
||||
return () => window.removeEventListener("keydown", onKeyDown);
|
||||
}, [selectScreen, selectedScreenId]);
|
||||
window.addEventListener("keyup", onKeyUp);
|
||||
window.addEventListener("blur", hold.end);
|
||||
return () => {
|
||||
hold.end();
|
||||
window.removeEventListener("keydown", onKeyDown);
|
||||
window.removeEventListener("keyup", onKeyUp);
|
||||
window.removeEventListener("blur", hold.end);
|
||||
};
|
||||
}, [selectScreen]);
|
||||
|
||||
const onViewportChange = useCallback((event: CanvasViewportChangeEvent) => {
|
||||
viewportChangeHandler.current?.(event);
|
||||
|
||||
@@ -1064,30 +1064,36 @@ code {
|
||||
opacity 170ms ease-in-out calc(var(--toolbar-motion) * 0.35),
|
||||
filter 170ms ease-in-out calc(var(--toolbar-motion) * 0.35);
|
||||
}
|
||||
/* Compare's count of changed screens rides on its button's corner. */
|
||||
.toolbar-button:has(> .toolbar-badge) { position: relative; }
|
||||
.toolbar-badge {
|
||||
/* The key that completes a chord, on a button's corner while its modifier is held: hold ⌃ and
|
||||
the toolbar's sections show 1, 2 and 3. Quiet: a small key in the element colour. */
|
||||
.toolbar-button:has(> .key-hint), .camera-action-button:has(> .key-hint), .collapsed-platform:has(> .key-hint), .compare-nav-picker:has(> .key-hint) { position: relative; }
|
||||
.key-hint {
|
||||
position: absolute;
|
||||
top: -6px;
|
||||
right: -6px;
|
||||
display: flex;
|
||||
min-width: 18px;
|
||||
height: 18px;
|
||||
min-width: 16px;
|
||||
height: 16px;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
padding: 0 5px;
|
||||
border-radius: 9px;
|
||||
/* Light theme's deep orange takes white text, as the Modified pill does; dark theme's light
|
||||
orange takes dark text. */
|
||||
color: #fff;
|
||||
background: var(--modified);
|
||||
box-shadow: 0 0 0 2px var(--surface);
|
||||
padding: 0 4px;
|
||||
border-radius: 5px;
|
||||
color: var(--text);
|
||||
background: var(--element);
|
||||
box-shadow: 0 0 0 2px var(--surface), 0 1px 2px rgb(0 0 0 / 0.12);
|
||||
font: inherit;
|
||||
font-size: 10px;
|
||||
font-weight: 700;
|
||||
font-weight: 600;
|
||||
line-height: 1;
|
||||
font-variant-numeric: tabular-nums;
|
||||
pointer-events: none;
|
||||
animation: key-hint-in 100ms ease-out;
|
||||
}
|
||||
:root[data-theme="dark"] .toolbar-badge { color: #0c0d0e; }
|
||||
@keyframes key-hint-in {
|
||||
from { opacity: 0; transform: translateY(2px); }
|
||||
to { opacity: 1; transform: none; }
|
||||
}
|
||||
@media (prefers-reduced-motion: reduce) { .key-hint { animation: none; } }
|
||||
/* Reduced motion: the bar takes its new width at once; only the names fade, without the blur. */
|
||||
@media (prefers-reduced-motion: reduce) {
|
||||
.toolbar-view-label,
|
||||
@@ -2386,7 +2392,6 @@ html [data-sonner-toaster][data-sonner-theme] {
|
||||
background: #000;
|
||||
}
|
||||
|
||||
|
||||
.image-placeholder-reason {
|
||||
display: block;
|
||||
max-width: 80%;
|
||||
|
||||
@@ -0,0 +1,84 @@
|
||||
// Which modifier keys are down right now, so a button can show the key that completes a chord
|
||||
// with them: hold ⌃ and the toolbar's Map, Screens and Compare show 1, 2 and 3. One listener for
|
||||
// the window; components subscribe and re-render only when the set of held modifiers changes.
|
||||
import { useSyncExternalStore } from "react";
|
||||
import { APPLE, isTyping, type Shortcut } from "./shortcuts";
|
||||
|
||||
export type HeldModifiers = { shift: boolean; ctrl: boolean; meta: boolean; alt: boolean };
|
||||
|
||||
const NONE: HeldModifiers = { shift: false, ctrl: false, meta: false, alt: false };
|
||||
// The modifiers physically down, and the ones the hints show: none while focus is in a field,
|
||||
// where a held Shift is for a capital letter, not for a chord. Focus can move by mouse with a
|
||||
// modifier still down, so the shown set is worked out again on every focus change too.
|
||||
let physical: HeldModifiers = NONE;
|
||||
let held: HeldModifiers = NONE;
|
||||
const listeners = new Set<() => void>();
|
||||
|
||||
function same(left: HeldModifiers, right: HeldModifiers): boolean {
|
||||
return left.shift === right.shift && left.ctrl === right.ctrl && left.meta === right.meta && left.alt === right.alt;
|
||||
}
|
||||
|
||||
function publish() {
|
||||
const next = isTyping(document.activeElement) ? NONE : physical;
|
||||
if (same(held, next)) return;
|
||||
held = same(next, NONE) ? NONE : next;
|
||||
for (const listener of listeners) listener();
|
||||
}
|
||||
|
||||
function onKey(event: KeyboardEvent) {
|
||||
physical = { shift: event.shiftKey, ctrl: event.ctrlKey, meta: event.metaKey, alt: event.altKey };
|
||||
publish();
|
||||
}
|
||||
|
||||
function clear() {
|
||||
physical = NONE;
|
||||
publish();
|
||||
}
|
||||
|
||||
function subscribe(listener: () => void) {
|
||||
if (listeners.size === 0) {
|
||||
window.addEventListener("keydown", onKey, true);
|
||||
window.addEventListener("keyup", onKey, true);
|
||||
// A chord that leaves the page (⌘Tab, a browser shortcut) never sends its key up here.
|
||||
window.addEventListener("blur", clear);
|
||||
document.addEventListener("visibilitychange", clear);
|
||||
document.addEventListener("focusin", publish);
|
||||
document.addEventListener("focusout", publish);
|
||||
}
|
||||
listeners.add(listener);
|
||||
return () => {
|
||||
listeners.delete(listener);
|
||||
if (listeners.size > 0) return;
|
||||
window.removeEventListener("keydown", onKey, true);
|
||||
window.removeEventListener("keyup", onKey, true);
|
||||
window.removeEventListener("blur", clear);
|
||||
document.removeEventListener("visibilitychange", clear);
|
||||
document.removeEventListener("focusin", publish);
|
||||
document.removeEventListener("focusout", publish);
|
||||
physical = NONE;
|
||||
held = NONE;
|
||||
};
|
||||
}
|
||||
|
||||
export function useHeldModifiers(): HeldModifiers {
|
||||
return useSyncExternalStore(subscribe, () => held, () => NONE);
|
||||
}
|
||||
|
||||
/** The modifiers a shortcut needs, on this keyboard: ⌘ for `mod` on Apple keyboards, Ctrl elsewhere. */
|
||||
export function shortcutModifiers(shortcut: Shortcut, apple = APPLE): HeldModifiers {
|
||||
return {
|
||||
shift: Boolean(shortcut.shift),
|
||||
ctrl: Boolean(shortcut.ctrl) || (Boolean(shortcut.mod) && !apple),
|
||||
meta: Boolean(shortcut.mod) && apple,
|
||||
alt: Boolean(shortcut.alt),
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* The key that completes `shortcut` with exactly the modifiers held, or nothing: a plain key has no
|
||||
* chord to complete, and a held modifier that is not the shortcut's shows nothing for it.
|
||||
*/
|
||||
export function heldKeyHint(shortcut: Shortcut, held: HeldModifiers, apple = APPLE): string | undefined {
|
||||
if (same(held, NONE)) return undefined;
|
||||
return same(held, shortcutModifiers(shortcut, apple)) ? shortcut.key : undefined;
|
||||
}
|
||||
@@ -2,8 +2,11 @@
|
||||
* Paging by holding a key. The first step lands on key down; holding past the initial delay keeps
|
||||
* stepping, each step a little sooner than the last until the floor, the way a held scrollbar arrow
|
||||
* or a spinner accelerates. The browser's own key repeat is ignored (its rate is a fixed OS setting),
|
||||
* so the hold is timed here and ends on key up, blur, or the end of the list.
|
||||
* so the hold is timed here and ends on key up, another key, blur, a field or dialog taking the
|
||||
* keyboard, or the end of the list.
|
||||
*/
|
||||
import { isTyping, modalOpen } from "./shortcuts";
|
||||
|
||||
export const HOLD_INITIAL_DELAY_MS = 250;
|
||||
export const HOLD_FIRST_INTERVAL_MS = 200;
|
||||
export const HOLD_FLOOR_INTERVAL_MS = 70;
|
||||
@@ -24,3 +27,93 @@ export function holdSchedule(count: number): number[] {
|
||||
}
|
||||
return times;
|
||||
}
|
||||
|
||||
export type KeyHold = {
|
||||
/**
|
||||
* Starts holding `code` after its first step already landed. `step` takes the next step and
|
||||
* says whether there was one; the hold ends by itself when there is not.
|
||||
*/
|
||||
begin: (code: string, step: () => boolean) => void;
|
||||
end: () => void;
|
||||
/**
|
||||
* Ends the hold when another key goes down, as the OS's own key repeat stops. A modifier does
|
||||
* not end it, so ⇧ or ⌘ can join a held key. Call it first in the listener, before any guard.
|
||||
*/
|
||||
interrupt: (event: KeyboardEvent) => void;
|
||||
/** Whether `code` is the key being held. */
|
||||
holding: (code: string) => boolean;
|
||||
};
|
||||
|
||||
const MODIFIER_KEYS = new Set(["Shift", "Control", "Alt", "Meta"]);
|
||||
|
||||
/** Whether the keyboard is still the page's: nothing is being typed into and no dialog is open. */
|
||||
function keyboardFree(): boolean {
|
||||
if (typeof document === "undefined") return true;
|
||||
return !isTyping(document.activeElement) && !modalOpen();
|
||||
}
|
||||
|
||||
// A glide moves at the stepped hold's speeds, in tap steps per second: one step per first
|
||||
// interval at first, easing up to one per floor interval.
|
||||
const GLIDE_START_RATE = 1000 / HOLD_FIRST_INTERVAL_MS;
|
||||
const GLIDE_TOP_RATE = 1000 / HOLD_FLOOR_INTERVAL_MS;
|
||||
const GLIDE_RAMP_MS = 1000;
|
||||
/** A glide picks up from rest over this long, so it does not lurch out of the tap's step. */
|
||||
const GLIDE_PICKUP_MS = 80;
|
||||
|
||||
/** How fast a glide moves `elapsed` milliseconds after it began, in tap steps per second. */
|
||||
export function glideRate(elapsed: number): number {
|
||||
const ramp = Math.min(1, elapsed / GLIDE_RAMP_MS);
|
||||
return GLIDE_START_RATE * Math.min(1, elapsed / GLIDE_PICKUP_MS)
|
||||
+ (GLIDE_TOP_RATE - GLIDE_START_RATE) * ramp * ramp * (3 - 2 * ramp);
|
||||
}
|
||||
|
||||
/**
|
||||
* For a continuous value (a zoom, a divider) a held key glides instead of stepping: from `delayMs`
|
||||
* on, `move` is called every frame with how far to go, in tap steps (fractions of one), until the
|
||||
* hold ends. `move` says whether it moved; at a limit it does not, and the hold ends there.
|
||||
*/
|
||||
export function glideWhileHeld(hold: KeyHold, code: string, delayMs: number, move: (steps: number) => boolean): void {
|
||||
const start = performance.now() + delayMs;
|
||||
let last = start;
|
||||
const frame = (now: number) => {
|
||||
if (!hold.holding(code)) return;
|
||||
if (now > start) {
|
||||
const steps = glideRate(now - start) * (now - Math.max(last, start)) / 1000;
|
||||
last = now;
|
||||
if (!move(steps)) {
|
||||
hold.end();
|
||||
return;
|
||||
}
|
||||
}
|
||||
requestAnimationFrame(frame);
|
||||
};
|
||||
requestAnimationFrame(frame);
|
||||
}
|
||||
|
||||
/** One held key at a time, timed on the schedule above. */
|
||||
export function createKeyHold(): KeyHold {
|
||||
let current: { code: string; timer: ReturnType<typeof setTimeout> } | undefined;
|
||||
const end = () => {
|
||||
if (current) clearTimeout(current.timer);
|
||||
current = undefined;
|
||||
};
|
||||
return {
|
||||
begin(code, step) {
|
||||
end();
|
||||
let count = 1;
|
||||
const tick = () => {
|
||||
const next = holdIntervalMs(count);
|
||||
// A field or a dialog took the keyboard mid-hold: end, rather than step behind it.
|
||||
if (!current || !keyboardFree() || !step()) { end(); return; }
|
||||
current = { code, timer: setTimeout(tick, next) };
|
||||
count += 1;
|
||||
};
|
||||
current = { code, timer: setTimeout(tick, HOLD_INITIAL_DELAY_MS) };
|
||||
},
|
||||
end,
|
||||
interrupt(event) {
|
||||
if (current && !event.repeat && event.code !== current.code && !MODIFIER_KEYS.has(event.key)) end();
|
||||
},
|
||||
holding: (code) => current?.code === code,
|
||||
};
|
||||
}
|
||||
@@ -3,6 +3,13 @@ import type { ConnectionGroup } from "./graph-model";
|
||||
export type MapKeyDirection = "up" | "down" | "left" | "right";
|
||||
type Point = { x: number; y: number };
|
||||
|
||||
const ARROW_WIDGETS = '[role="menu"], [role="menubar"], [role="listbox"], [role="tree"], [role="tablist"], [role="radiogroup"], [role="slider"]';
|
||||
|
||||
/** Whether the key's target is a widget whose arrows are its own (a menu item, a list, tabs); the map leaves those keys to it. */
|
||||
export function arrowsOwnedBy(target: EventTarget | null): boolean {
|
||||
return target instanceof Element && target.closest(ARROW_WIDGETS) !== null;
|
||||
}
|
||||
|
||||
/** Arrow keys and their Vim twins; anything else is not a map move. */
|
||||
export function mapKeyDirection(event: Pick<KeyboardEvent, "key" | "altKey" | "ctrlKey" | "metaKey" | "shiftKey">): MapKeyDirection | undefined {
|
||||
if (event.altKey || event.ctrlKey || event.metaKey || event.shiftKey) return undefined;
|
||||
@@ -52,3 +59,23 @@ export function mapKeyTarget(
|
||||
}
|
||||
return best?.id;
|
||||
}
|
||||
|
||||
/**
|
||||
* The screen an arrow selects when nothing is: the one at the edge the key moves away from, as
|
||||
* the Screens page's arrows enter at the first or last card. ↓ takes the topmost screen, ↑ the
|
||||
* bottom one, → the leftmost, ← the rightmost; ties go to the screen nearest the other axis's start.
|
||||
*/
|
||||
export function mapKeyEntry(
|
||||
structure: { positions: Map<string, Point> },
|
||||
direction: MapKeyDirection,
|
||||
): string | undefined {
|
||||
const vertical = direction === "up" || direction === "down";
|
||||
const sign = direction === "down" || direction === "right" ? 1 : -1;
|
||||
let best: { id: string; along: number; across: number } | undefined;
|
||||
for (const [id, point] of structure.positions) {
|
||||
const along = sign * (vertical ? point.y : point.x);
|
||||
const across = vertical ? point.x : point.y;
|
||||
if (!best || along < best.along || (along === best.along && across < best.across)) best = { id, along, across };
|
||||
}
|
||||
return best?.id;
|
||||
}
|
||||
@@ -16,7 +16,7 @@ export type Shortcut = {
|
||||
key: string;
|
||||
};
|
||||
|
||||
const APPLE = typeof navigator !== "undefined"
|
||||
export const APPLE = typeof navigator !== "undefined"
|
||||
&& /Mac|iPhone|iPad|iPod/.test(navigator.platform || navigator.userAgent);
|
||||
|
||||
/**
|
||||
@@ -61,6 +61,11 @@ export const SHORTCUTS = {
|
||||
panel: {
|
||||
right: plain("KeyI", "I"),
|
||||
},
|
||||
/** T is the Viewer's own light or dark theme; ⇧T is the captured app's appearance, in a report that has both. */
|
||||
appearance: {
|
||||
theme: plain("KeyT", "T"),
|
||||
app: shift("KeyT", "T"),
|
||||
},
|
||||
/** Canvas edits follow the platform-standard history keys. */
|
||||
edit: {
|
||||
undo: mod("KeyZ", "Z"),
|
||||
|
||||