@guidepup/playwright - npm Package Compare versions

Comparing version 0.1.0 to 0.2.0

lib/index.d.ts

 export { voTest } from "./voTest";
+export { voConfig } from "./voConfig";

lib/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.voTest = void 0;
+exports.voConfig = exports.voTest = void 0;
 var voTest_1 = require("./voTest");
 Object.defineProperty(exports, "voTest", { enumerable: true, get: function () { return voTest_1.voTest; } });
+var voConfig_1 = require("./voConfig");
+Object.defineProperty(exports, "voConfig", { enumerable: true, get: function () { return voConfig_1.voConfig; } });

lib/voConfig.js

@@ -15,3 +15,4 @@ "use strict";
         /**
-         * VoiceOver can only control headed applications.
+         * Although VoiceOver can interact with headless applications, not all
+         * behaviours work as expected.
          */
@@ -18,0 +19,0 @@ headless: false,

lib/voTest.js

@@ -7,3 +7,2 @@ "use strict";
 const guidepup_1 = require("@guidepup/guidepup");
-const voConfig_1 = require("./voConfig");
 const PLAYWRIGHT_APPLICATION = "Playwright";
@@ -31,2 +30,1 @@ /**
 exports.voTest = voTest;
-voTest.use(voConfig_1.voConfig);

package.json

 {
   "name": "@guidepup/playwright",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Screen-reader driver for Playwright.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -54,5 +54,27 @@ <h1 align="center">Guidepup Playwright</h1>
 
+## Playwright Config
+
+In your `playwright.config.ts` add the following for the best results with
+Guidepup for VoiceOver automation. 💥
+
+```ts
+import { devices, PlaywrightTestConfig } from "@playwright/test";
+import { voConfig } from "@guidepup/playwright";
+
+const config: PlaywrightTestConfig = {
+  ...voConfig,
+  
+  // Your custom config ...
+};
+
+export default config;
+```
+
+Check out the configuration this adds [here](./src/voConfig.ts). 👀
+
 ## Resources
 
-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.
+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.
 
@@ -59,0 +81,0 @@ ## License

No alert changes

Improved metrics

Total package byte prevSize

104702

increased by0.62%

Lines of code

74

increased by2.78%

Number of lines in readme file

83

increased by36.07%

No dependency changes