@guidepup/playwright 0.7.5 → 0.8.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Craig Morten
+Copyright (c) 2023 Craig Morten
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,6 +1,6 @@
 <h1 align="center">Guidepup Playwright</h1>
 <p align="center">
-  <i>Screen-reader driver for Playwright.</i>
+  <i>Screen reader driver for Playwright tests.</i>
 </p>
 <p align="center">
   <a href="https://www.npmjs.com/package/@guidepup/playwright"><img alt="@guidepup/playwright available on NPM" src="https://img.shields.io/npm/v/@guidepup/playwright" /></a>
@@ -8,10 +8,10 @@
   <a href="https://github.com/guidepup/guidepup-playwright/blob/main/LICENSE"><img alt="@guidepup/playwright uses the MIT license" src="https://img.shields.io/github/license/guidepup/guidepup-playwright" /></a>
 </p>
 <p align="center">
-  Providing a reliable set of APIs to automate your screen-reader a11y workflows in Playwright.
+  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:
 
@@ -19,7 +19,7 @@ Install `@guidepup/playwright` to your project:
 npm install --save-dev @guidepup/playwright
 ```
 
-And get cracking with your first screen-reader tests in Playwright! 🚀
+And get cracking with your first screen reader tests in Playwright!
 
 ```ts
 import { voTest as test } from "@guidepup/playwright";
@@ -30,26 +30,26 @@ test.describe("Playwright VoiceOver", () => {
     page,
     voiceOver,
   }) => {
-    // Navigate to Guidepup GitHub page 🎉
+    // Navigate to Guidepup GitHub page
     await page.goto("https://github.com/guidepup/guidepup", {
       waitUntil: "domcontentloaded",
     });
 
-    // Wait for page to be ready and interact 🙌
+    // Wait for page to be ready and interact
     await expect(page.locator('header[role="banner"]')).toBeVisible();
     await voiceOver.interact();
 
-    // Move across the page menu to the Guidepup heading using VoiceOver 🔎
+    // Move across the page menu to the Guidepup heading using VoiceOver
     while ((await voiceOver.itemText()) !== "Guidepup heading level 1") {
       await voiceOver.perform(voiceOver.keyboard.commands.findNextHeading);
     }
 });
 ```
 
-## Playwright Config 🐕‍🦺
+## Playwright Config
 
 In your `playwright.config.ts` add the following for the best results with
-Guidepup for VoiceOver automation. 💥
+Guidepup for VoiceOver automation.
 
 ```ts
 import { devices, PlaywrightTestConfig } from "@playwright/test";
@@ -64,9 +64,9 @@ const config: PlaywrightTestConfig = {
 export default config;
 ```
 
-Check out the configuration this adds [in the voConfig.ts file](./src/voConfig.ts). 👀
+Check out the configuration this adds [in the voConfig.ts file](./src/voConfig.ts).
 
-## Environment Setup 🐾
+## Environment Setup
 
 Setup your environment for screen-read automation with [`@guidepup/setup`](https://github.com/guidepup/setup):
 
@@ -78,19 +78,19 @@ If you are using GitHub Actions, check out the dedicated [`guidepup/setup-action
 
 ```yaml
 - name: Setup Environment
-  uses: guidepup/setup-action@0.5.0
+  uses: guidepup/setup-action@0.7.0
 ```
 
-## Example 👀
+## Example
 
 Check out [this VoiceOver example](./example/).
 
-## See Also 🐶
+## 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
+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,7 +1,7 @@
 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.
+ * browser with a running instance of the VoiceOver screen reader for MacOS.
  *
  * A fresh started VoiceOver instance `vo` is provided to each test.
  */

package/lib/voTest.js

@@ -1,21 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.voTest = void 0;
-/* eslint-disable no-empty-pattern */
 const test_1 = require("@playwright/test");
 const guidepup_1 = require("@guidepup/guidepup");
-const PLAYWRIGHT_APPLICATION = "Playwright";
+const applicationNameMap = {
+    chromium: "Chromium",
+    chrome: "Google Chrome",
+    "chrome-beta": "Google Chrome Beta",
+    msedge: "Microsoft Edge",
+    "msedge-beta": "Microsoft Edge Beta",
+    "msedge-dev": "Microsoft Edge Dev",
+    firefox: "Nightly",
+    webkit: "Playwright",
+};
 /**
  * These tests extend the default Playwright environment that launches the
- * browser with a running instance of the VoiceOver screen-reader for MacOS.
+ * browser with a running instance of the VoiceOver screen reader for MacOS.
  *
  * A fresh started VoiceOver instance `vo` is provided to each test.
  */
 const voTest = test_1.test.extend({
-    voiceOver: async ({}, use) => {
+    voiceOver: async ({ browserName }, use) => {
         try {
             await guidepup_1.voiceOver.start();
-            await (0, guidepup_1.macOSActivate)(PLAYWRIGHT_APPLICATION);
+            await (0, guidepup_1.macOSActivate)(applicationNameMap[browserName]);
             await use(guidepup_1.voiceOver);
         }
         finally {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@guidepup/playwright",
-  "version": "0.7.5",
-  "description": "Screen-reader driver for Playwright.",
+  "version": "0.8.0",
+  "description": "Screen reader driver for Playwright tests.",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "author": "Craig Morten <craig.morten@hotmail.co.uk>",
@@ -29,11 +29,11 @@
     "lint": "eslint . --ext .ts",
     "lint:fix": "yarn lint --fix",
     "prepublish": "yarn build",
-    "pretest": "npx playwright install webkit",
-    "test": "playwright test -c ./example/playwright.config.ts ./example/tests/playwright.spec.ts"
+    "pretest": "npx playwright install webkit chromium",
+    "test": "playwright test -c ./example/playwright.config.ts ./example/tests/"
   },
   "dependencies": {
-    "@guidepup/guidepup": "^0.14.7"
+    "@guidepup/guidepup": "^0.15.0"
   },
   "devDependencies": {
     "@playwright/test": "^1.28.1",

package/yarn.lock

@@ -29,10 +29,10 @@
     minimatch "^3.0.4"
     strip-json-comments "^3.1.1"
 
-"@guidepup/guidepup@^0.14.7":
-  version "0.14.7"
-  resolved "https://registry.yarnpkg.com/@guidepup/guidepup/-/guidepup-0.14.7.tgz#d83ba5295126b2f391de7c10d0554d5d09b82614"
-  integrity sha512-q/uSktR+eumcgqTmo7ZqW2EMhw3o/ki1btxHWqGxBWJgoQHPz6+zWqzv15VgcmSipG8EOCpcfbWOnEOE00o53A==
+"@guidepup/guidepup@^0.15.0":
+  version "0.15.0"
+  resolved "https://registry.yarnpkg.com/@guidepup/guidepup/-/guidepup-0.15.0.tgz#d9cd40f933f31c03d65f6bef9a31fee953654cc0"
+  integrity sha512-MUPtcp57e6Ehtgtn29nb1spObIz4dUA3aTj+FL4RGBGmv2q+YPXJ0zEKP2MP04QsTAJ5fL8vN2nddmnGGxSS+w==
 
 "@humanwhocodes/config-array@^0.9.2":
   version "0.9.2"