π¬ A browser extension and desktop app that turns your clicks into step-by-step guides with annotated screenshots π
TypeScript browser-extensionchrome-extensiondocumentationfirefox-extensionguide-generatorlocal-firstmanifest-v3privacy-firstproductivityreactscreenshotstep-by-step-guidetutorialtypescriptworkflowwxt
import { app, nativeImage, screen } from 'electron';
import {
captureCursorDisplay,
cursorPoint,
elementAt,
elementLookupAvailable,
focusedWindow,
keyLabel,
resolveKey,
InputHook,
listDisplays,
} from '../src/main/capture';
function distinctColours(png: Buffer): number {
const bitmap = nativeImage.createFromBuffer(png).toBitmap();
const seen = new Set<string>();
for (let i = 0; i < bitmap.length && seen.size <= 64; i += 4 * 997) {
seen.add(`${bitmap[i]},${bitmap[i + 1]},${bitmap[i + 2]}`);
}
return seen.size;
}
type Verdict = 'ok' | 'fail' | 'n/a';
function line(name: string, verdict: Verdict, detail: string): void {
const tag = verdict === 'ok' ? 'ok ' : verdict === 'n/a' ? 'n/a ' : 'FAIL';
process.stdout.write(`${tag} ${name.padEnd(18)} ${detail}\n`);
}
app.disableHardwareAcceleration();
app.whenReady().then(async () => {
let failures = 0;
const displays = listDisplays();
const displaysOk = displays.length > 0 && displays.every((d) => d.scaleFactor > 0 && d.bounds.width > 0);
if (!displaysOk) failures++;
line('displays', displaysOk ? 'ok' : 'fail', displays.map((d) => `${d.bounds.width}x${d.bounds.height}@${d.scaleFactor}x`).join(', '));
const point = cursorPoint();
line('cursor', Number.isFinite(point.x) ? 'ok' : 'fail', `${point.x},${point.y}`);
try {
const shot = await captureCursorDisplay();
const ok = shot.png.length > 0 && shot.width > 0;
if (!ok) failures++;
line('screenshot', ok ? 'ok' : 'fail', `${shot.width}x${shot.height}, ${(shot.png.length / 1024).toFixed(0)} KB png`);
const display = screen.getDisplayNearestPoint(point);
const expected = {
width: Math.round(display.bounds.width * shot.scaleFactor),
height: Math.round(display.bounds.height * shot.scaleFactor),
};
const sized = shot.width === expected.width && shot.height === expected.height;
if (!sized) failures++;
line(
'frame covers display',
sized ? 'ok' : 'fail',
`${shot.width}x${shot.height}, expected ${expected.width}x${expected.height} at ${shot.scaleFactor}x`,
);
const colours = distinctColours(shot.png);
const painted = colours > 1;
if (!painted) failures++;
line('frame is not blank', painted ? 'ok' : 'fail', `${colours} distinct colours sampled`);
} catch (error) {
failures++;
line('screenshot', 'fail', error instanceof Error ? error.message : String(error));
}
const win = await focusedWindow();
if (!win.ok && win.reason !== 'unsupported-session') failures++;
line(
'focused window',
win.ok ? 'ok' : win.reason === 'unsupported-session' ? 'n/a' : 'fail',
win.ok ? `${win.window.app.name} β ${win.window.title ?? '(untitled)'}` : `${win.reason}: ${win.detail}`,
);
const lookup = await elementLookupAvailable();
const element = lookup ? await elementAt(point) : null;
if (lookup && !element) failures++;
line(
'element at point',
lookup ? (element ? 'ok' : 'fail') : 'n/a',
lookup
? element
? `${element.role ?? 'no role'} β ${element.ariaLabel ?? '(unnamed)'}`
: 'no element resolved under the cursor'
: 'the accessibility addon has no build for this platform',
);
const named = lookup ? await keyLabel(28) : null;
const typed = lookup ? await resolveKey(30, false, false, false) : null;
const keysOk = named === 'Enter' && typed?.length === 1;
if (lookup && !keysOk) failures++;
line(
'key names',
lookup ? (keysOk ? 'ok' : 'fail') : 'n/a',
lookup
? `scancode 28 names ${named ?? 'nothing'}, scancode 30 types ${typed ?? 'nothing'} on the foreground layout`
: 'no addon on this platform',
);
const hook = new InputHook();
const started = await hook.start(() => {});
if (!started.ok && started.reason !== 'unsupported-session') failures++;
line(
'input hook',
started.ok ? 'ok' : started.reason === 'unsupported-session' ? 'n/a' : 'fail',
started.ok ? 'started' : `${started.reason}: ${started.detail}`,
);
hook.stop();
process.stdout.write(
`\n${failures === 0 ? 'no failures β n/a lines are platform limits, not bugs' : `${failures} failure(s)`}\n`,
);
app.exit(failures === 0 ? 0 : 1);
});