@guidepup/playwright 0.2.1 → 0.6.0

package/README.md

@@ -11,7 +11,7 @@
   Providing a reliable set of APIs to automate your screen-reader a11y workflows in Playwright.
 </p>
 
-## Getting Started
+## Getting Started 🦮
 
 Install `@guidepup/playwright` to your project:
 
@@ -28,7 +28,7 @@ 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/", {
@@ -36,22 +36,24 @@ test.describe("Playwright VoiceOver", () => {
     });
 
     // Interact with the page 🙌
-    await vo.commandInteractWithItem();
+    await voiceOver.interact();
 
     // Move across the navigation menu to the search bar using VoiceOver 🔎
-    while (!(await vo.getLastSpokenPhrase())?.startsWith("Search")) {
-      await vo.moveNext();
+    while (!(await voiceOver.lastSpokenPhrase())?.startsWith("Search")) {
+      await voiceOver.next();
     }
 
     // Search for Safari 👀
-    await page.keyboard.type("Safari");
-    await vo.performAction();
+    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");
   });
 });
 ```
 
-## Playwright Config
+## Playwright Config 🐕‍🦺
 
 In your `playwright.config.ts` add the following for the best results with
 Guidepup for VoiceOver automation. 💥
@@ -69,14 +71,29 @@ const config: PlaywrightTestConfig = {
 export default config;
 ```
 
-Check out the configuration this adds [here](./src/voConfig.ts). 👀
+Check out the configuration this adds [in the voConfig.ts file](./src/voConfig.ts). 👀
 
-## Resources
+## Environment Setup 🐾
+
+Setup your environment for screen-read automation with [`@guidepup/setup`](https://github.com/guidepup/setup):
+
+```bash
+npx @guidepup/setup
+```
+
+If you are using GitHub Actions, check out the dedicated [`guidepup/setup-action`](https://github.com/marketplace/actions/guidepup-setup):
+
+```yaml
+- name: Setup Environment
+  uses: guidepup/setup-action@0.1.3
+```
+
+## See Also 🐶
 
 Checkout the core [`@guidepup/guidepup`](https://github.com/guidepup/guidepup)
 project to learn more about how you can automate your screen-reader workflows
 using Guidepup.
 
-## License
+## License 🐩
 
 [MIT](https://github.com/guidepup/guidepup/blob/main/LICENSE)

package/lib/voTest.d.ts

@@ -1,4 +1,3 @@
-import { VoiceOver } from "@guidepup/guidepup";
 /**
  * These tests extend the default Playwright environment that launches the
  * browser with a running instance of the VoiceOver screen-reader for MacOS.
@@ -6,6 +5,6 @@ import { VoiceOver } from "@guidepup/guidepup";
  * A fresh started VoiceOver instance `vo` is provided to each test.
  */
 declare const voTest: import("@playwright/test").TestType<import("@playwright/test").PlaywrightTestArgs & import("@playwright/test").PlaywrightTestOptions & {
-    vo: VoiceOver;
+    voiceOver: any;
 }, import("@playwright/test").PlaywrightWorkerArgs & import("@playwright/test").PlaywrightWorkerOptions>;
 export { voTest };

package/lib/voTest.js

@@ -12,16 +12,14 @@ const PLAYWRIGHT_APPLICATION = "Playwright";
  * A fresh started VoiceOver instance `vo` is provided to each test.
  */
 const voTest = test_1.test.extend({
-    vo: async ({}, use) => {
-        const vo = new guidepup_1.VoiceOver();
+    voiceOver: async ({}, use) => {
         try {
-            await vo.start();
+            await guidepup_1.voiceOver.start();
             await (0, guidepup_1.macOSActivate)(PLAYWRIGHT_APPLICATION);
-            await use(vo);
+            await use(guidepup_1.voiceOver);
         }
         finally {
-            vo.stopLog();
-            await vo.stop();
+            await guidepup_1.voiceOver.stop();
         }
     },
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guidepup/playwright",
-  "version": "0.2.1",
+  "version": "0.6.0",
   "description": "Screen-reader driver for Playwright.",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -26,12 +26,12 @@
     "ci": "yarn clean && yarn lint && yarn build",
     "clean": "rimraf lib",
     "compile": "tsc",
-    "lint": "eslint . --ext .js,.jsx,.ts,.tsx",
+    "lint": "eslint . --ext .ts",
     "lint:fix": "yarn lint --fix",
     "prepublish": "yarn build"
   },
   "dependencies": {
-    "@guidepup/guidepup": "^0.9.3"
+    "@guidepup/guidepup": "^0.13.0"
   },
   "devDependencies": {
     "@playwright/test": "^1.17.1",

package/yarn.lock

@@ -456,10 +456,10 @@
     minimatch "^3.0.4"
     strip-json-comments "^3.1.1"
 
-"@guidepup/guidepup@^0.9.3":
-  version "0.9.3"
-  resolved "https://registry.yarnpkg.com/@guidepup/guidepup/-/guidepup-0.9.3.tgz#b0e6826e85286b8d7e3d28f3d24f849ced91e456"
-  integrity sha512-8FIb20T7vlTjPmI8f6cM9Mn4pxWzEx938V0Au1m36jMPcrE1lK1e5ejQfHcYFwL7o50pULm4SwU6eJOvfCE/pQ==
+"@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"