pw-repl 0.12.8 → 0.14.0

package/lib/written.js

@@ -0,0 +1,67 @@
+// The files the REPL wrote this session, and for whom, so close and stop can say which are still
+// there to clean up. Kept in memory only, and nothing is removed.
+const fs = require('fs');
+const path = require('path');
+const { state, onShutdownEnd } = require('./state');
+const out = require('./output');
+const { FILES_LEFT } = require('./util');
+
+const written = new Map();
+
+// kind: what it is, as the summary counts it (screenshot, video, steps file, profile, watch file).
+function noteWritten(file, kind, client = state.client) {
+  written.set(path.resolve(file), { kind, client: client ?? null });
+}
+
+// A file renamed (record off <file>) is still the same one.
+function noteMoved(from, to) {
+  const entry = written.get(path.resolve(from));
+  if (!entry) return;
+  written.delete(path.resolve(from));
+  written.set(path.resolve(to), entry);
+}
+
+function remaining(client) {
+  const files = [];
+  for (const [file, entry] of written) {
+    if (entry.client !== (client ?? null)) continue;
+    try { files.push({ file, kind: entry.kind, size: fs.statSync(file).size }); } catch {}
+  }
+  return files;
+}
+
+function sizeText(bytes) {
+  if (bytes < 1024 * 1024) return `${Math.max(1, Math.round(bytes / 1024))} KB`;
+  return `${Number((bytes / 1024 / 1024).toFixed(1))} MB`;
+}
+
+// For close: the client's own files, in full.
+function ownFilesText(client) {
+  const files = remaining(client);
+  if (!files.length) return null;
+  return [`Files you wrote that are still there; remove what is no longer needed:`, ...files.map(f => `  ${f.file} (${sizeText(f.size)})`)].join('\n');
+}
+
+const plural = (n, kind) => `${n} ${kind}${n === 1 ? '' : 's'}`;
+
+// For stop: one line for each client that left files, each with what and where.
+function summaryLines() {
+  const clients = [...new Set([...written.values()].map(e => e.client))];
+  const lines = [];
+  for (const client of clients) {
+    const files = remaining(client);
+    if (!files.length) continue;
+    const kinds = new Map();
+    for (const f of files) kinds.set(f.kind, (kinds.get(f.kind) || 0) + 1);
+    const folders = [...new Set(files.map(f => `${path.dirname(f.file)}/`))];
+    const bytes = files.reduce((sum, f) => sum + f.size, 0);
+    const who = client ? `by ${client}` : 'without a client name';
+    lines.push(`${FILES_LEFT} ${who}: ${plural(files.length, 'file')}, ${sizeText(bytes)} (${[...kinds].map(([k, n]) => plural(n, k)).join(', ')}) in ${folders.join(' and ')}`);
+  }
+  return lines;
+}
+
+// After every recording has been saved, so its file is whole.
+onShutdownEnd(() => { for (const line of summaryLines()) out.log(line); });
+
+module.exports = { noteWritten, noteMoved, ownFilesText, summaryLines };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pw-repl",
-  "version": "0.12.8",
+  "version": "0.14.0",
   "description": "Text REPL for driving an existing Chromium through Playwright over CDP",
   "keywords": [
     "playwright",

package/skill/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: pw-repl
-description: Inspect and drive a Chromium browser, possibly one the user is using, through the pw-repl REPL - tabs, page snapshots, clicks and typing, the mouse at a point (moves, buttons, wheel), requests and their bodies, console messages, waiting for pages and elements, choosing files, faking, patching or delaying responses, cutting or slowing the network, emulating a phone, dark mode, a locale or a timezone, recording what the user does, profiling what makes a page slow (long tasks, forced layouts, input delay, dropped frames), and recording a video of a tab, with a pointer and on-screen captions. Use when asked to look at, debug or test something in a web page, in an existing Chromium with remote debugging or in one it starts itself.
+description: Inspect and drive a Chromium browser, possibly one the user is using, through the pw-repl REPL - tabs, page snapshots, clicks and typing, the mouse at a point (moves, buttons, wheel), requests and their bodies, console messages, what a page copied to the clipboard, waiting for pages and elements, choosing files, faking, patching or delaying responses, cutting or slowing the network, emulating a phone, dark mode, a locale or a timezone, recording what the user does, profiling what makes a page slow (long tasks, forced layouts, input delay, dropped frames), and recording a video of a tab, with a pointer and on-screen captions. Use when asked to look at, debug or test something in a web page, in an existing Chromium with remote debugging or in one it starts itself.
 allowed-tools: Bash(pw-repl:*) Bash(npx pw-repl@latest:*)
 ---
 
@@ -93,7 +93,7 @@ client of your own: `PW_CLIENT=<name>` (or `send -c <name>`), with a name that s
   as `[server:<name>]` lines.
 - `modes` and `tab` say which client turned each mode on and opened each tab. `modes off --mine` turns
   off only what you turned on; `tab close <url-part>` closes a tab you opened.
-- Commands run one at a time, from every client: a long one (`capture on 60`, `sleep`) holds the rest.
+- Commands run one at a time, from every client: a long one (`capture on 60s`, `sleep`) holds the rest.
 
 A REPL of your own, on a socket of its own, is for a browser of your own (`--launch`), or when you are
 asked for one. Several REPLs on one browser each see every tab but list only their own modes, and can
@@ -105,16 +105,19 @@ A REPL in a terminal stops at its prompt (`quit`, or Ctrl-C); `send quit` is ref
 
 ```bash
 pw-repl send tab
-pw-repl send -t 90 'screenshot -d 60'   # wait longer than the 20s default
+pw-repl send -t 90s 'screenshot -d 60s'   # wait longer than the 20s default
 ```
 
+Times, in send's `-t` and in every command, are in milliseconds, as in Playwright, or in seconds with an
+`s`: `-t 90000` or `-t 90s`.
+
 Always send commands with `pw-repl send`; don't type into the pane yourself, except `quit` at the prompt
 of a REPL of your own, which `send` refuses. The words after `send` are the command. For `fill`, `type`,
 `select`, `press`, `upload` and `wait`, a word quoted in your shell stays one word
 (`pw-repl send fill "text=Your name" Ada`, `pw-repl send wait text "Showing 1"`); other commands get the words as they are, joined by
 spaces (`pw-repl send eval "document.title + ' x'"`). A command that takes only a selector takes the
 whole line, spaces and all: `pw-repl send click "text=Your name"`. `send`'s own options (`-t`, `-c`, `-e`,
-`-s`, `--no-vars`) go before the command or after it (`pw-repl send open <url> -t 30`); after `--`, every
+`-s`, `--no-vars`) go before the command or after it (`pw-repl send open <url> -t 30s`); after `--`, every
 word is the command's. It works however the REPL was started:
 
 - `run` (in tmux): `send` types the command into the tmux pane and reads the result back off the screen.
@@ -227,6 +230,9 @@ pw-repl send -c <name> close                        # your modes off; tab close
   lists what is on in every tab (the prompt shows the selected tab's, e.g. `(watch routes:1) pw>`);
   `modes off` turns off every mode in every tab.
 - Someone may be attached to the REPL's tmux session; killing the session ends it for them too.
+- What a page copied (a Copy button): click it, then `clipboard` prints it. In a headless browser
+  (`--launch`) that is the browser's own clipboard. In one with a window it is the user's, which may
+  hold a password, so `clipboard` refuses there without `--shared-clipboard`: ask the user first.
 - To point something out, to the user or in a screenshot, `highlight <ref|selector>` draws a box over it
   without changing the page (`--style=<css>` restyles it; `highlight off` hides them), without
   Playwright's locator label unless `highlight --labels on`.
@@ -249,6 +255,8 @@ pw-repl send -c <name> close                        # your modes off; tab close
   not by `send`. Without it, a REPL on a socket of its own saves them next to its socket, and any other
   in `/tmp`. `screenshot` prints each file's path; other REPLs may save theirs in the same place. Remove
   only your own, and keep those too if they are needed, e.g. as evidence or as something to hand over.
+  `close` (as a client, `-c <name>`) lists every file you wrote that is still there: screenshots,
+  videos, saved profiles and watches.
 - `PW_ENDPOINT` / `PW_TMUX_SESSION` — defaults for `send -e` / `-s`. `PW_SOCKET` — the socket `serve`
   serves on and `send` looks for when neither is given (default `/tmp/pw-repl.sock`).