feat: allow custom nvda install directory (#26)

Author: cmorten

.github/CODEOWNERS.md

@@ -0,0 +1 @@
+* @cmorten

.github/CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing to this repository
+
+First of all, thanks for taking the time to read this document and contributing to our codebase!
+
+## Getting started
+
+If you're working on an existing issue then awesome! Let us know by dropping a comment in the issue.
+
+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!
+
+## Working on your feature
+
+### Branching
+
+On this project we follow mainline development (or trunk based development), and our default branch is `main`.
+
+Therefore you need to branch from `main` and merge into `main`.
+
+### Coding style
+
+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.
+
+We use `eslint` and `prettier` for linting. You can check and correct the code style using the following commands:
+
+```console
+# Check linting
+yarn lint
+
+# Fix linting
+yarn lint:fix
+```
+
+## Opening a PR
+
+Once you're confident your branch is ready to review, open a PR against `main` on this repo.
+
+Please use the PR template as a guide, but if your change doesn't quite fit it, feel free to customize.
+
+## Merging and publishing
+
+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

@@ -0,0 +1,11 @@
+# Issue
+
+Setup:
+
+- NPM version: <replace_with_npm_version (try `npm --version`)>
+- OS Platform: <replace_with_os_platform>
+- OS Release: <replace_with_os_release_version>
+
+## Details
+
+> 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

@@ -0,0 +1,11 @@
+# Issue
+
+Fixes #<issue_number>.
+
+## Details
+
+> Please replace this quote block with a brief summary of PR purpose and code changes.
+
+## CheckList
+
+- [ ] Has been tested (where required).

.github/workflows/test.yml

@@ -27,3 +27,22 @@ jobs:
           name: artifacts
           path: |
             **/recordings/**/*
+  test-nvda-install-dir:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-2019, windows-2022]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: yarn install --frozen-lockfile
+      - run: yarn ci:nvda-install-dir
+      - run: Get-ChildItem $env:USERPROFILE\nvda
+      - uses: actions/upload-artifact@v3
+        if: always()
+        with:
+          name: artifacts
+          path: |
+            **/recordings/**/*

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+<[email protected]>. All complaints will be reviewed and investigated promptly
+and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

README.md

@@ -1,13 +1,21 @@
-<h1 align="center">Guidepup Setup</h1>
-<p align="center">
-  <i>Setup your environment for screen reader test automation.</i>
-</p>
-<p align="center">
-  <a href="https://www.npmjs.com/package/@guidepup/setup"><img alt="Guidepup Setup available on NPM" src="https://img.shields.io/npm/v/@guidepup/setup" /></a>
-  <a href="https://www.npmjs.com/package/@guidepup/setup"><img alt="Guidepup available on NPM" src="https://img.shields.io/npm/dt/@guidepup/setup"></a>
-  <a href="https://github.com/guidepup/setup/actions/workflows/test.yml"><img alt="Guidepup Setup test workflows" src="https://github.com/guidepup/setup/workflows/Test/badge.svg" /></a>
-  <a href="https://github.com/guidepup/setup/blob/main/LICENSE"><img alt="Guidepup Setup uses the MIT license" src="https://img.shields.io/github/license/guidepup/setup" /></a>
-</p>
+# Guidepup Setup
+
+<a href="https://www.npmjs.com/package/@guidepup/setup"><img alt="Guidepup Setup available on NPM" src="https://img.shields.io/npm/v/@guidepup/setup" /></a>
+<a href="https://github.com/guidepup/setup/actions/workflows/test.yml"><img alt="Guidepup Setup test workflows" src="https://github.com/guidepup/setup/workflows/Test/badge.svg" /></a>
+<a href="https://github.com/guidepup/setup/blob/main/LICENSE"><img alt="Guidepup Setup uses the MIT license" src="https://img.shields.io/github/license/guidepup/setup" /></a>
+
+## [Documentation](https://www.guidepup.dev/docs/guides/automated-environment-setup)
+
+[![MacOS Big Sur Support](https://img.shields.io/badge/macos-Big_Sur-blue.svg?logo=apple)](https://apps.apple.com/id/app/macos-big-sur/id1526878132)
+[![MacOS Monetary Support](https://img.shields.io/badge/macos-Monetary-blue.svg?logo=apple)](https://apps.apple.com/us/app/macos-monterey/id1576738294)
+[![MacOS Ventura Support](https://img.shields.io/badge/macos-Ventura-blue.svg?logo=apple)](https://apps.apple.com/us/app/macos-ventura/id1638787999)
+[![Windows 10 Support](https://img.shields.io/badge/windows-10-blue.svg?logo=windows10)](https://www.microsoft.com/en-gb/software-download/windows10ISO)
+[![Windows Server 2019 Support](https://img.shields.io/badge/windows_server-2019-blue.svg?logo=windows)](https://www.microsoft.com/en-us/evalcenter/evaluate-windows-server-2019)
+[![Windows Server 2022 Support](https://img.shields.io/badge/windows_server-2022-blue.svg?logo=windows)](https://www.microsoft.com/en-us/evalcenter/evaluate-windows-server-2022)
+
+This package sets up your environment for screen reader automation.
+
+It enables automation for <a href="https://www.guidepup.dev/docs/api/class-voiceover"><b>VoiceOver on MacOS</b></a> and <a href="https://www.guidepup.dev/docs/api/class-nvda"><b>NVDA on Windows</b></a>.
 
 ## Getting Started
 
@@ -17,17 +25,11 @@ Run this command:
 npx @guidepup/setup
 ```
 
-And get cracking with your screen reader test automation code!
+And get cracking with your screen reader automation code!
 
 ## Usage
 
-If you are running this command locally, you might find it prompts you to pass in credentials so that it can using UI automation to change a checkbox value which enables the automation of VoiceOver. If you are uncomfortable with providing your credentials you can manually achieve these steps by following the [manual VoiceOver setup documentation](https://www.guidepup.dev/docs/guides/manual-voiceover-setup).
-
-If you are running this command in CI/CD, it is recommended to add the `--ci` flag to prevent interactive prompts:
-
-```console
-npx @guidepup/setup --ci
-```
+### GitHub Actions
 
 If you are using GitHub Actions, check out the dedicated [`guidepup/setup-action`](https://github.com/marketplace/actions/guidepup-setup):
 
@@ -36,21 +38,35 @@ If you are using GitHub Actions, check out the dedicated [`guidepup/setup-action
   uses: guidepup/setup-action
 ```
 
+### MacOS
+
+If you are running this command locally, you might find it prompts you to pass in credentials so that it can using UI automation to change a checkbox value which enables the automation of VoiceOver. If you are uncomfortable with providing your credentials you can manually achieve these steps by following the [manual VoiceOver setup documentation](https://www.guidepup.dev/docs/guides/manual-voiceover-setup).
+
+If you are running this command in CI/CD, it is recommended to add the `--ci` flag to prevent interactive prompts:
+
+```console
+npx @guidepup/setup --ci
+```
+
 If you are encountering errors in CI for MacOS you can pass a `--record` flag to the command which will output a screen-recording of the setup to a `./recordings/` directory:
 
 ```console
 npx @guidepup/setup --ci --record
 ```
 
-Check out the [Documentation Website](https://www.guidepup.dev/docs/guides/environment) for more information.
+### Windows
 
-## Windows
-
-### NVDA Installation
+#### NVDA Installation
 
 When running on windows a portable NVDA instance compatible with Guidepup will be installed to a temporary directory. The location of this installation directory is stored in the Windows registry under the key `HKCU\Software\Guidepup\Nvda`.
 
-### Foreground Timeout Lock
+If you want to specify the directory that NVDA is installed to you can pass a `--nvda-install-dir` flag to the command:
+
+```console
+npx @guidepup/setup --nvda-install-dir <NVDA_INSTALLATION_DIRECTORY>
+```
+
+#### Foreground Timeout Lock
 
 Modern versions of Windows have a setting which prevents new application instances launching in front of other applications in quick succession, requiring over 3 minutes between activations before it will actually show the window - in the interim it launches the window minimized.
 
@@ -63,18 +79,18 @@ To mitigate this the setup script updates two keys in the Windows registry under
 
 Both of these are set to `0` by the setup script.
 
-## See Also
+## Powerful Tooling
 
 Check out some of the other Guidepup modules:
 
-- [`@guidepup/guidepup`](https://github.com/guidepup/guidepup/)
-- [`@guidepup/playwright`](https://github.com/guidepup/guidepup-playwright/)
-
-## Support
-
-- VoiceOver on MacOS
-- NVDA on Windows
+- [`@guidepup/guidepup`](https://github.com/guidepup/guidepup/) - Reliable automation for your screen reader a11y workflows through JavaScript supporting VoiceOver and NVDA.
+- [`@guidepup/playwright`](https://github.com/guidepup/guidepup-playwright/) - Seemless integration of Guidepup with Playwright.
+- [`@guidepup/virtual-screen-reader`](https://github.com/guidepup/virtual-screen-reader/) - Reliable unit testing for your screen reader a11y workflows.
+- [`@guidepup/jest`](https://github.com/guidepup/jest/) - Jest matchers for reliable unit testing of your screen reader a11y workflows.
 
-## License
+## Resources
 
-[MIT](https://github.com/guidepup/setup/blob/main/LICENSE)
+- [Documentation](https://www.guidepup.dev/docs/guides/automated-environment-setup)
+- [Contributing](.github/CONTRIBUTING.md)
+- [Changelog](https://github.com/guidepup/setup/releases)
+- [MIT License](https://github.com/guidepup/setup/blob/main/LICENSE)

SECURITY.md

@@ -0,0 +1,43 @@
+# Security Policies and Procedures
+
+This document outlines security procedures and general policies for the Guidepup
+project.
+
+- [Reporting a Bug](#reporting-a-bug)
+- [Disclosure Policy](#disclosure-policy)
+- [Comments on this Policy](#comments-on-this-policy)
+
+## Reporting a Bug
+
+The Guidepup maintainers and community take all security bugs in Guidepup seriously.
+Thank you for improving the security of Guidepup. We appreciate your efforts and
+responsible disclosure and will make every effort to acknowledge your
+contributions.
+
+Report security bugs by emailing the lead maintainer in the
+[CODEOWNERS](.github/CODEOWNERS.md) file.
+
+The lead maintainer will acknowledge your email, and will send a response
+indicating the next steps in handling your report. After the initial reply
+to your report, the maintainer team will endeavor to keep you informed of the
+progress towards a fix and full announcement, and may ask for additional
+information or guidance.
+
+Report security bugs in third-party modules to the person or team maintaining
+the module.
+
+## Disclosure Policy
+
+When the maintainer team receives a security bug report, they will assign it to a
+primary handler. This person will coordinate the fix and release process,
+involving the following steps:
+
+- Confirm the problem and determine the affected versions.
+- Audit code to find any potential similar problems.
+- Prepare fixes for all releases still under maintenance. These fixes will be
+  released as fast as possible to GitHub.
+
+## Comments on this Policy
+
+If you have suggestions on how this process could be improved please submit a
+pull request.