feat: vo -> voiceOver **BREAKING** (#1)

Author: cmorten

README.md

@@ -28,26 +28,26 @@ import { expect } from "@playwright/test";
 test.describe("Playwright VoiceOver", () => {
   test("I can navigate the Playwright website using VoiceOver", async ({
     page,
-    vo,
+    voiceOver,
   }) => {
     // Navigate to Playwright website 🎉
     await page.goto("https://playwright.dev/", {
       waitUntil: "domcontentloaded",
     });
 
     // Interact with the page 🙌
-    await vo.interact();
+    await voiceOver.interact();
 
     // Move across the navigation menu to the search bar using VoiceOver 🔎
-    while (!(await vo.lastSpokenPhrase())?.startsWith("Search")) {
-      await vo.next();
+    while (!(await voiceOver.lastSpokenPhrase())?.startsWith("Search")) {
+      await voiceOver.next();
     }
 
     // Search for Safari 👀
-    await vo.type("Safari");
-    await vo.press("ArrowDown");
-    await vo.press("ArrowUp");
-    await Promise.all([page.waitForNavigation(), vo.act()]);
+    await voiceOver.type("Safari");
+    await voiceOver.press("ArrowDown");
+    await voiceOver.press("ArrowUp");
+    await Promise.all([page.waitForNavigation(), voiceOver.act()]);
     expect(page.url()).toBe("https://playwright.dev/docs/browsers#webkit");
   });
 });

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guidepup/playwright",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Screen-reader driver for Playwright.",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -31,7 +31,7 @@
     "prepublish": "yarn build"
   },
   "dependencies": {
-    "@guidepup/guidepup": "^0.12.0"
+    "@guidepup/guidepup": "^0.13.0"
   },
   "devDependencies": {
     "@playwright/test": "^1.17.1",

src/voTest.ts

@@ -1,6 +1,6 @@
 /* eslint-disable no-empty-pattern */
 import { test } from "@playwright/test";
-import { VoiceOver, macOSActivate } from "@guidepup/guidepup";
+import { voiceOver, macOSActivate } from "@guidepup/guidepup";
 
 const PLAYWRIGHT_APPLICATION = "Playwright";
 
@@ -10,16 +10,14 @@ const PLAYWRIGHT_APPLICATION = "Playwright";
  *
  * A fresh started VoiceOver instance `vo` is provided to each test.
  */
-const voTest = test.extend<{ vo: VoiceOver }>({
-  vo: async ({}, use) => {
-    const vo = new VoiceOver();
-
+const voTest = test.extend<{ voiceOver }>({
+  voiceOver: async ({}, use) => {
     try {
-      await vo.start();
+      await voiceOver.start();
       await macOSActivate(PLAYWRIGHT_APPLICATION);
-      await use(vo);
+      await use(voiceOver);
     } finally {
-      await vo.stop();
+      await voiceOver.stop();
     }
   },
 });

yarn.lock

@@ -456,10 +456,10 @@
     minimatch "^3.0.4"
     strip-json-comments "^3.1.1"
 
-"@guidepup/guidepup@^0.12.0":
-  version "0.12.0"
-  resolved "https://registry.yarnpkg.com/@guidepup/guidepup/-/guidepup-0.12.0.tgz#59602aab356464868e7eb9e4284c0ef3796de6b9"
-  integrity sha512-bVMnLDaJoKdt+zy+g1+SOZx3Cw5DE8F1DAll+Kt9JQ2HnPgnSovmscmj1ofgeSxFXOoxjb0a90fzGhLyOeLOJQ==
+"@guidepup/guidepup@^0.13.0":
+  version "0.13.0"
+  resolved "https://registry.yarnpkg.com/@guidepup/guidepup/-/guidepup-0.13.0.tgz#7995ec599283d02a9532c9f79aca2ca3aa2e3c47"
+  integrity sha512-U56KXtxkyZa9m7q9l4et3AtkU+0Z+cYEnF4vA5ZgUbJCfQr66F2Rn04HPhIDDEZ/2PMYP5NsdDONSWu23ESQ4w==
 
 "@humanwhocodes/config-array@^0.9.2":
   version "0.9.2"