@guidepup/playwright 0.2.0 → 0.5.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:
 
@@ -36,22 +36,24 @@ test.describe("Playwright VoiceOver", () => {
     });
 
     // Interact with the page 🙌
-    await vo.commandInteractWithItem();
+    await vo.interact();
 
     // Move across the navigation menu to the search bar using VoiceOver 🔎
-    while (!(await vo.getLastSpokenPhrase())?.startsWith("Search")) {
-      await vo.moveNext();
+    while (!(await vo.lastSpokenPhrase())?.startsWith("Search")) {
+      await vo.next();
     }
 
     // Search for Safari 👀
-    await page.keyboard.type("Safari");
-    await vo.performAction();
+    await vo.type("Safari");
+    await vo.press("ArrowDown");
+    await vo.press("ArrowUp");
+    await Promise.all([page.waitForNavigation(), vo.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 🐾
 
-Checkout the core [@guidepup/guidepup](https://github.com/guidepup/guidepup)
+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.js

@@ -20,7 +20,6 @@ const voTest = test_1.test.extend({
             await use(vo);
         }
         finally {
-            vo.stopLog();
             await vo.stop();
         }
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guidepup/playwright",
-  "version": "0.2.0",
+  "version": "0.5.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.2"
+    "@guidepup/guidepup": "^0.12.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.2":
-  version "0.9.2"
-  resolved "https://registry.yarnpkg.com/@guidepup/guidepup/-/guidepup-0.9.2.tgz#a1e2212f714eb3dd5d65c7749807919e7028c5f9"
-  integrity sha512-0W3MSKZ8eJcHW7Y0fUWulMkLhxjOZjrpAGzXghcy3vX5dgL75ouDmi/raT+ATACueSuo/P0EGWEm+QH2OHfmlg==
+"@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==
 
 "@humanwhocodes/config-array@^0.9.2":
   version "0.9.2"