Skip to content

smashingmagazine/auto-vo

 
 

Repository files navigation

auto-VO

Automate VoiceOver for testing web applications.

Setup

Enable AppleScript

  • Open VoiceOver Utility and check "Allow VoiceOver to be controller with AppleScript".

Installation

$ npm install auto-vo

Usage

CLI

Running the cli outputs the phrases spoken by the screen reader to stdout.

$ npx auto-vo --url https://example.com --limit 5 --until 'Example'

--url URL - where URL is the url to test

--limit n - where n is the maximum number of cursor moves

--until s - where s is a search term, after which the script ends. supercedes --limit.

Node Module

$ npm install --save-dev auto-vo
import { run } from 'auto-vo';

(async function() {
    const options = { url: "https://www.example.com", limit: 10, until: 'Example' };

    const announcements = await run(options);

    console.log(announcements);
})();

Example Test Runner

Using mocha/chai:

import { run } from 'auto-vo';
import { expect } from 'chai';

describe('loading example.com', async () => {
  it('returns announcements', async () => {
    const options = { url: "https://www.example.com", limit: 10, until: 'Example' };

    const announcements = await run(options);

    expect(announcements).to.include.members(["Example Domain web content"]);
  }).timeout(5000);
});

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 70.0%
  • JavaScript 30.0%