Skip to content

Commit 0720481

Browse files
cmortencmorten
authored
feat: NVDA support (#13)
* feat: BREAKING CHANGE: voTest has been renamed to voiceOverTest * feat: BREAKING CHANGE: voConfig has been renamed to screenReaderConfig * feat: introduce new nvdaTest for supporting NVDA integration * feat: introduce new voiceOver.navigateToWebContent() and nvda.navigateToWebContent() to make it easier to focus on web content after page navigation. * docs: new API documented in README * test: CI now runs full suite against NVDA and browser combinations
1 parent f7f5649 commit 0720481

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1141
-279
lines changed

‎.github/CODEOWNERS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @cmorten

‎.github/CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to this repository
2+
3+
First of all, thanks for taking the time to read this document and contributing to our codebase!
4+
5+
## Getting started
6+
7+
If you're working on an existing issue then awesome! Let us know by dropping a comment in the issue.
8+
9+
If it's a new bug fix or feature that you would like to contribute, then please raise an issue so it can be tracked (and to help out others who are experiencing the same issue / want the new thing know that it's being looked at!). Be sure to check for existing issues before raising your own!
10+
11+
## Working on your feature
12+
13+
### Branching
14+
15+
On this project we follow mainline development (or trunk based development), and our default branch is `main`.
16+
17+
Therefore you need to branch from `main` and merge into `main`.
18+
19+
### Coding style
20+
21+
Generally try to match the style and conventions of the code around your changes. Ultimately we want code that is clear, concise, consistent and easy to read.
22+
23+
We use `eslint` and `prettier` for linting. You can check and correct the code style using the following commands:
24+
25+
```console
26+
# Check linting
27+
yarn lint
28+
29+
# Fix linting
30+
yarn lint:fix
31+
```
32+
33+
### Tests
34+
35+
Before opening a PR, please run the following command to make sure your branch will build and pass all the checks and tests:
36+
37+
```console
38+
yarn test
39+
```
40+
41+
## Opening a PR
42+
43+
Once you're confident your branch is ready to review, open a PR against `main` on this repo.
44+
45+
Please use the PR template as a guide, but if your change doesn't quite fit it, feel free to customize.
46+
47+
## Merging and publishing
48+
49+
When your feature branch / PR has been tested and has an approval, it is then ready to merge. Please contact a maintainer to action the merge.

‎.github/ISSUE_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Issue
2+
3+
Setup:
4+
5+
- Node version: <replace_with_node_version (try `node --version`)>
6+
- Guidepup version: <replace_with_guidepup_version>
7+
- Guidepup Playwright version: <replace_with_guidepup_playwright_version>
8+
- OS Platform: <replace_with_os_platform>
9+
- OS Release: <replace_with_os_release_version>
10+
11+
## Details
12+
13+
> Please replace this quote block with the details of the feature / bug you wish to be addressed. If it is a bug please do your best to add steps to reproduce.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Issue
2+
3+
Fixes #<issue_number>.
4+
5+
## Details
6+
7+
> Please replace this quote block with a brief summary of PR purpose and code changes.
8+
9+
## CheckList
10+
11+
- [ ] Has been tested (where required).

‎.github/workflows/test-nvda.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Test NVDA
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test-nvda:
11+
runs-on: ${{ matrix.os }}
12+
strategy:
13+
matrix:
14+
os: [windows-2019, windows-2022]
15+
browser: [chromium, firefox]
16+
steps:
17+
- uses: actions/checkout@v3
18+
- uses: actions/setup-node@v3
19+
with:
20+
node-version: 20
21+
- name: Guidepup Setup
22+
uses: guidepup/setup-action@0.13.0
23+
with:
24+
record: true
25+
- run: yarn install --frozen-lockfile
26+
- run: yarn pretest
27+
- run: yarn test:nvda:${{ matrix.browser }}
28+
- uses: actions/upload-artifact@v3
29+
if: always()
30+
continue-on-error: true
31+
with:
32+
name: artifacts
33+
path: |
34+
**/test-results/**/*
35+
**/recordings/**/*

‎.github/workflows/test-voiceover.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
record: true
2525
- run: yarn install --frozen-lockfile
2626
- run: yarn pretest
27-
- run: yarn test:${{ matrix.browser }}
27+
- run: yarn test:voiceover:${{ matrix.browser }}
2828
- uses: actions/upload-artifact@v3
2929
if: always()
3030
continue-on-error: true

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
<craig.morten@hotmail.co.uk>. All complaints will be reviewed and investigated promptly
64+
and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
<https://www.contributor-covenant.org/faq>. Translations are available at
128+
<https://www.contributor-covenant.org/translations>.

0 commit comments

Comments
 (0)