cypress-voice-plugin 1.0.0

package/.github/workflows/main.yml

@@ -0,0 +1,14 @@
+name: Cypress Tests
+
+on: push
+
+jobs:
+  cypress-run:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      # Install npm dependencies, cache them correctly
+      # and run all Cypress tests
+      - name: Cypress run
+        uses: cypress-io/github-action@v6

package/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+
+Thanks for being willing to contribute!
+
+**Working on your first Pull Request?** You can learn more from [Your First Pull Request on GitHub](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork)
+
+## Project setup
+
+1. Fork and clone the repo
+2. Run `npm install` to install dependencies
+3. Create a branch for your PR with `git checkout -b pr/your-branch-name`
+
+> Tip: Keep your `main` branch pointing at the original repository and make
+> pull requests from branches on your fork. To do this, run:
+>
+> ```
+> git remote add upstream https://github.com/dennisbergevin/cypress-voice-plugin
+> git fetch upstream
+> git branch --set-upstream-to=upstream/main main
+> ```
+>
+> This will add the original repository as a "remote" called "upstream," Then
+> fetch the git information from that remote, then set your local `main`
+> branch to use the upstream main branch whenever you run `git pull`. Then you
+> can make all of your pull request branches based on this `main` branch.
+> Whenever you want to update your version of `main`, do a regular `git pull`.
+
+## Committing and Pushing changes
+
+Please make sure to run the tests, located in `cypress/e2e`, before you commit your changes. You can run
+`npx cypress open`. Make sure to include any test changes (if they exist) in your commit.
+
+## Help needed
+
+Please checkout the [the open issues](https://github.com/dennisbergevin/cypress-voice-plugin/issues)
+
+Also, please watch the repo and respond to questions/bug reports/feature
+requests! Thanks!

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024, Dennis Bergevin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,113 @@
+![cypress-voice picture](./content/cypress-voice.png)
+
+A close companion to other iterations of Text to speech (TTS), this assistive Cypress plugin offers an opt-in auditory tool to hear results of a spec file run to support local development and debugging.
+
+> [!IMPORTANT]  
+> This plugin is _currently_ only for running `cypress open` locally. See [TODO](#todo) for future plans.
+
+Using `cypress open`, this Cypress plugin covers the following auditory feedback at the end of a spec file run:
+
+- Whether a spec passed, passed with retries, failed or has all tests skipped
+- The specific number of tests that passed, passed with retries, failed or were skipped
+- The total spec run time
+- Voice rate/pitch/volume adjustment sliders
+
+## 🎬 Demo - Turn on the sound!
+
+https://github.com/dennisbergevin/cypress-voice-plugin/assets/65262795/9810ed2e-dce5-4d0d-93a4-35d7cd18e5e8
+
+## 🤝 Benefits
+
+There are accessible benefits to auditory feedback, but two general audiences came to mind in developing this plugin:
+
+1. For those who prefer an auditory style of feedback.
+2. For those who are seeking a tool to help quickly analyze a spec run.
+
+## 📦 Installation
+
+Install this package:
+
+```sh
+npm install --save-dev cypress-voice-plugin
+```
+
+In `cypress/support/e2e.js` (For E2E tests) and/or `cypress/support/component.js` (For Component tests),
+
+```js
+import "cypress-voice-plugin";
+```
+
+## 🦺 Setup
+
+Within `cypress open`, the voice plugin is enabled via a [Cypress environment variable](https://docs.cypress.io/guides/guides/environment-variables).
+
+> [!NOTE]  
+> You can only enable a single value for `voiceResultType` at a time. `voiceResultType` and/or `voiceTime` can be enabled together or independently.
+
+| Environment variable | Value        | Can this variable alone enable plugin? | Purpose                                                                                                             | Sample Spoken Result                                          |
+| -------------------- | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
+| `voiceResultType`    | `"simple"`   | ✅ Yes                                 | High-level result of entire spec file run.                                                                          | "Spec passed."                                                |
+| `voiceResultType`    | `"detailed"` | ✅ Yes                                 | In addition to what is provided by `"simple"`, the counts of tests passed, passed with retries, failed and skipped. | "Spec failed: 1 test passed, 2 tests failed, 1 test skipped." |
+| `voiceTime`          | `true`       | ✅ Yes                                 | The time of entire spec file run.                                                                                   | "Total time: 34 seconds"                                      |
+
+## 🏃‍♀️ Voice adjustments
+
+To adjust the rate, pitch, and/or volume of spoken results within the browser when using this plugin, utilize the slider once inside a spec file:
+
+![cypress-voice-slider](./content/cypress-voice-slider.gif)
+
+## 🌏 Language support
+
+Under the hood, the plugin utilizes in-browser text-to-speech capabilities via the [`speechSynthesis` Web Speech API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API/Using_the_Web_Speech_API#speech_synthesis).
+
+As the plugin does not set a language itself, [`speechSynthesis` is able to detect the language to use](https://developer.mozilla.org/en-US/docs/Web/API/SpeechSynthesisUtterance/lang):
+
+> If unset, the app's (i.e. the <html> lang value) lang will be used, or the user-agent default if that is unset too.
+
+## 📕 Example Environment Variable Setups
+
+The following options are suggestions of how to set the environment variable(s). A more comprehensive [guide on environment variable setting](https://docs.cypress.io/guides/guides/environment-variables#Setting) can be found within official Cypress documentation.
+
+### Setup using `cypress.env.json`
+
+Add environment variable(s) to a created `cypress.env.json` file.
+
+Example:
+
+```js
+{
+  "voiceTime": true,
+  "voiceResultType": "detailed",
+}
+```
+
+This is a useful method for handling local use of this plugin, particularly if you add `cypress.env.json` to your `.gitignore` file. This way, enabling the plugin functionality via environment variable can be different for each developer machine rather than committed to the remote repository.
+
+From official Cypress docs, more information on the [`cypress.env.json` method](https://docs.cypress.io/guides/guides/environment-variables#Option-2-cypressenvjson).
+
+### Setup using `--env`
+
+Alternatively, append the environment variable to the end of your `cypress open` cli command:
+
+```shell
+npx cypress open --env voiceResultType=simple
+```
+
+Or, combine multiple variables in one command to hear both result and total run time:
+
+```shell
+npx cypress open --env voiceResultType=detailed,voiceTime=true
+```
+
+From official Cypress docs, more information on the [`--env` method](https://docs.cypress.io/guides/guides/environment-variables#Option-4---env).
+
+## TODO
+
+- [ ] Look into additional ways to modify the voice and language for spoken content within the plugin
+- [ ] Add functionality for `cypress run`
+
+## Contributions
+
+Feel free to open a pull request or drop any feature request or bug in the [issues](https://github.com/dennisbergevin/cypress-voice-plugin/issues).
+
+Please see more details in the [contributing doc](./CONTRIBUTING.md).

package/addStyles.js

@@ -0,0 +1,147 @@
+export const addStyles = () => {
+  const hasStyles = top?.document.querySelector("#rateStyle");
+  const hasRate = top?.document.querySelector("#rate");
+  const hasPitch = top?.document.querySelector("#pitch");
+  const hasVolume = top?.document.querySelector("#volume");
+
+  const styles = `
+    .reporter header {
+        overflow: visible;
+        z-index: 2;
+      }
+    .reporter label {
+        background-color: inherit;
+        color: inherit;
+        font-weight: bold;
+        font-size: 11px
+      }
+    #rate-control {
+        display: flex;
+        align-items: center;
+      }
+    #rate {
+        position: relative;
+        display: inline-block;
+        overflow-block: auto;
+        cursor: grab;
+      }
+      /* Apply a "closed-hand" cursor during drag operation. */
+    #rate:active {
+        cursor: grabbing;
+        cursor: -moz-grabbing;
+        cursor: -webkit-grabbing;
+      }
+    #pitch-control {
+        display: flex;
+        align-items: center;
+      }
+    #pitch {
+        position: relative;
+        display: inline-block;
+        overflow-block: auto;
+        cursor: grab;
+      }
+      /* Apply a "closed-hand" cursor during drag operation. */
+    #pitch:active {
+        cursor: grabbing;
+        cursor: -moz-grabbing;
+        cursor: -webkit-grabbing;
+      }
+    #volume-control {
+        display: flex;
+        align-items: center;
+      }
+    #volume {
+        position: relative;
+        display: inline-block;
+        overflow-block: auto;
+        cursor: grab;
+      }
+      /* Apply a "closed-hand" cursor during drag operation. */
+    #volume:active {
+        cursor: grabbing;
+        cursor: -moz-grabbing;
+        cursor: -webkit-grabbing;
+      }
+      `;
+  // Add styles
+  if (!hasStyles) {
+    const reporter = top?.document.querySelector("#unified-reporter");
+    const reporterStyle = document.createElement("style");
+    reporterStyle.setAttribute("id", "rateStyle");
+    reporterStyle.innerHTML = styles;
+    reporter?.appendChild(reporterStyle);
+  }
+
+  if (!hasRate && !hasPitch && !hasVolume) {
+    const header = top?.document.querySelector("#unified-reporter header");
+    const headerRateSliderDiv = document.createElement("div");
+    const headerRateSliderLabel = document.createElement("label");
+    const headerRateSliderInput = document.createElement("input");
+
+    headerRateSliderLabel.setAttribute("for", "rate");
+    headerRateSliderLabel.innerText = "Voice rate: ";
+    headerRateSliderDiv.setAttribute("id", "rate-control");
+
+    headerRateSliderInput.setAttribute("id", "rate");
+    headerRateSliderInput.setAttribute("step", "0.1");
+    headerRateSliderInput.setAttribute("value", "1");
+    headerRateSliderInput.setAttribute("max", "1.3");
+    headerRateSliderInput.setAttribute("min", "0.3");
+    headerRateSliderInput.setAttribute("type", "range");
+    headerRateSliderInput.setAttribute("aria-valuenow", "1");
+    headerRateSliderInput.setAttribute("aria-label", "Voice rate of speed");
+    headerRateSliderInput.setAttribute("aria-valuetext", "Normal voice rate");
+
+    header?.appendChild(headerRateSliderDiv);
+    headerRateSliderDiv?.appendChild(headerRateSliderLabel);
+    headerRateSliderDiv?.appendChild(headerRateSliderInput);
+
+    const headerPitchSliderDiv = document.createElement("div");
+    const headerPitchSliderLabel = document.createElement("label");
+    const headerPitchSliderInput = document.createElement("input");
+
+    headerPitchSliderLabel.setAttribute("for", "pitch");
+    headerPitchSliderLabel.innerText = "Voice pitch: ";
+    headerPitchSliderDiv.setAttribute("id", "pitch-control");
+
+    headerPitchSliderInput.setAttribute("id", "pitch");
+    headerPitchSliderInput.setAttribute("step", "0.1");
+    headerPitchSliderInput.setAttribute("value", "1");
+    headerPitchSliderInput.setAttribute("max", "1.3");
+    headerPitchSliderInput.setAttribute("min", "0.3");
+    headerPitchSliderInput.setAttribute("type", "range");
+    headerPitchSliderInput.setAttribute("aria-valuenow", "1");
+    headerPitchSliderInput.setAttribute("aria-label", "Voice pitch");
+    headerPitchSliderInput.setAttribute("aria-valuetext", "Normal voice pitch");
+
+    header?.appendChild(headerPitchSliderDiv);
+    headerPitchSliderDiv?.appendChild(headerPitchSliderLabel);
+    headerPitchSliderDiv?.appendChild(headerPitchSliderInput);
+
+    const headerVolumeSliderDiv = document.createElement("div");
+    const headerVolumeSliderLabel = document.createElement("label");
+    const headerVolumeSliderInput = document.createElement("input");
+
+    headerVolumeSliderLabel.setAttribute("for", "volume");
+    headerVolumeSliderLabel.innerText = "Voice volume: ";
+    headerVolumeSliderDiv.setAttribute("id", "volume-control");
+
+    headerVolumeSliderInput.setAttribute("id", "volume");
+    headerVolumeSliderInput.setAttribute("step", "0.1");
+    headerVolumeSliderInput.setAttribute("value", "1");
+    headerVolumeSliderInput.setAttribute("max", "1");
+    headerVolumeSliderInput.setAttribute("min", "0");
+    headerVolumeSliderInput.setAttribute("type", "range");
+    headerVolumeSliderInput.setAttribute("aria-valuenow", "1");
+    headerVolumeSliderInput.setAttribute("aria-label", "Voice volume");
+    headerVolumeSliderInput.setAttribute(
+      "aria-valuetext",
+      "Normal voice volume"
+    );
+
+    header?.appendChild(headerVolumeSliderDiv);
+    headerVolumeSliderDiv?.appendChild(headerVolumeSliderLabel);
+    headerVolumeSliderDiv?.appendChild(headerVolumeSliderInput);
+  }
+};

package/cypress/e2e/combinedResultTime.cy.js

@@ -0,0 +1,18 @@
+// Running the test in `cypress open` will allow you to check the assertion pass for the expected message
+// The browser will not speak the message
+
+describe("Voice result and time", () => {
+  it(
+    "Announces short passing test with result and time",
+    { env: { voiceResultType: "detailed", voiceTime: true } },
+    () => {
+      const synth = window.speechSynthesis;
+      synth.speak = (event) => {
+        const text = event.text;
+        expect(text).to.eq(
+          "Spec passed: 1 test passed. Total time: Less than 1 second."
+        );
+      };
+    }
+  );
+});

package/cypress/e2e/failedVoiceResult.cy.js

@@ -0,0 +1,30 @@
+// Running the test in `cypress open` will allow you to check the assertion pass for the expected message
+// The browser will not speak the message
+
+describe("Failing voice", () => {
+  it(
+    "Announces failed test without time",
+    {
+      env: {
+        voiceResultType: "simple",
+      },
+    },
+    () => {
+      // Trigger a "Spec failed" TTS on failure
+      cy.on("fail", () => {
+        const message = new SpeechSynthesisUtterance("Spec failed.");
+        speechSynthesis.speak(message);
+      });
+
+      cy.get("body", { timeout: 25 }).should("not.exist");
+
+      const synth = window.speechSynthesis;
+
+      synth.speak = (event) => {
+        const char = event.text;
+
+        expect(char).to.eq("Spec failed.");
+      };
+    }
+  );
+});

package/cypress/e2e/noPlugin.cy.js

@@ -0,0 +1,5 @@
+describe("No plugin enabled", () => {
+  it("Passes without plugin enabled", () => {
+    expect(1).to.eq(1);
+  });
+});

package/cypress/e2e/passedVoiceResult.cy.js

@@ -0,0 +1,17 @@
+// Running the test in `cypress open` will allow you to check the assertion pass for the expected message
+// The browser will not speak the message
+
+describe("Passing voice", () => {
+  it(
+    "Announces passed test",
+    { env: { voiceResultType: "simple", voiceTime: false } },
+    () => {
+      const synth = window.speechSynthesis;
+      synth.speak = (event) => {
+        const char = event.text;
+
+        expect(char).to.eq("Spec passed.");
+      };
+    }
+  );
+});

package/cypress/e2e/retriedVoiceResult.cy.js

@@ -0,0 +1,27 @@
+// Running the test in `cypress open` will allow you to check the assertion pass for the expected message
+// The browser will not speak the message
+
+describe("Voice on retries", () => {
+  it(
+    "Announces short retried test",
+    {
+      retries: 1,
+      env: { voiceResultType: "detailed", voiceTime: false },
+    },
+    () => {
+      // this test will fail on first try, but pass on second
+
+      if (Cypress.currentRetry === 0) {
+        expect(1).to.eq(2);
+      } else {
+        const synth = window.speechSynthesis;
+        synth.speak = (event) => {
+          const text = event.text;
+          expect(text).to.eq(
+            "Spec passed with retries: 1 test passed with retries."
+          );
+        };
+      }
+    }
+  );
+});

package/cypress/e2e/testResultsOnly.cy.js

@@ -0,0 +1,16 @@
+// Running the test in `cypress open` will allow you to check the assertion pass for the expected message
+// The browser will not speak the message
+
+describe("Test results only", () => {
+  it(
+    "Announces short passing test with only test results",
+    { env: { voiceResultType: "detailed", voiceTime: false } },
+    () => {
+      const synth = window.speechSynthesis;
+      synth.speak = (event) => {
+        const text = event.text;
+        expect(text).to.eq("Spec passed: 1 test passed.");
+      };
+    }
+  );
+});

package/cypress/e2e/voiceTime.cy.js

@@ -0,0 +1,16 @@
+// Running the test in `cypress open` will allow you to check the assertion pass for the expected message
+// The browser will not speak the message
+
+describe("Voice time", () => {
+  it(
+    "Announces short passing test with only time",
+    { env: { voiceTime: true, voiceResultType: false } },
+    () => {
+      const synth = window.speechSynthesis;
+      synth.speak = (event) => {
+        const text = event.text;
+        expect(text).to.eq("Total time: Less than 1 second.");
+      };
+    }
+  );
+});

package/cypress/support/commands.js

@@ -0,0 +1,37 @@
+/// <reference types="cypress" />
+// ***********************************************
+// This example commands.ts shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+//
+//
+// -- This is a parent command --
+// Cypress.Commands.add('login', (email, password) => { ... })
+//
+//
+// -- This is a child command --
+// Cypress.Commands.add('drag', { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add('dismiss', { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite('visit', (originalFn, url, options) => { ... })
+//
+// declare global {
+//   namespace Cypress {
+//     interface Chainable {
+//       login(email: string, password: string): Chainable<void>
+//       drag(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       dismiss(subject: string, options?: Partial<TypeOptions>): Chainable<Element>
+//       visit(originalFn: CommandOriginalFn, url: string, options: Partial<VisitOptions>): Chainable<Element>
+//     }
+//   }
+// }

package/cypress/support/e2e.js

@@ -0,0 +1,21 @@
+// ***********************************************************
+// This example support/e2e.ts is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import "./commands.js";
+import "../../index.js";
+
+// Alternatively you can use CommonJS syntax:
+// require('./commands')

package/cypress.config.js

@@ -0,0 +1,9 @@
+const { defineConfig } = require("cypress");
+
+module.exports = defineConfig({
+  e2e: {
+    setupNodeEvents(on, config) {
+      // implement node event listeners here
+    },
+  },
+});

package/index.js

@@ -0,0 +1,284 @@
+import { addStyles } from "./addStyles";
+
+// Voice plugin to announce spec result when Cypress runner UI is open (cypress open)
+if (
+  (Cypress.env("voiceResultType") === "simple" ||
+    Cypress.env("voiceResultType") === "detailed" ||
+    Cypress.env("voiceTime")) &&
+  Cypress.config("isInteractive")
+) {
+  // Cancel any ongoing spoken results when a new spec is selected mid-speech
+  // Apply styles for voice rate slider bar
+  Cypress.on("test:before:run", () => {
+    const voice = window.speechSynthesis;
+    voice.cancel();
+    addStyles();
+  });
+
+  Cypress.on("test:after:run", (config, test) => {
+    // Additional context of test index
+    // To account for loops where there is one test per describe and suite names may stay
+    // And to account for both specs with multiple suites or only one suite
+    const lastTestIndex = test.order;
+
+    // Querying the headed Cypress browser to find number of total tests in spec
+    const testNumber = window.top?.document.querySelectorAll(".test").length;
+
+    // Checking the current test index is either equal to the last index of the suite or the test context
+    const currentTestIsLast = lastTestIndex === testNumber;
+
+    // Checks within the document for a failure state
+    const failed = window.top?.document.querySelector(".runnable-failed");
+    // Checks within the document for a retried state to determine if retry occurred
+    const retried = window.top?.document.querySelector(".runnable-retried");
+    // Checks within the document for a passed state
+    const passed = window.top?.document.querySelector(".runnable-passed");
+    // Checks within the document for a skipped state
+    const skipped = window.top?.document.querySelector(".runnable-pending");
+
+    // Rate toggle for speed of spoken text
+    const rate = window.top?.document.querySelector("#rate");
+
+    // Pitch toggle for pitch of spoken text
+    const pitch = window.top?.document.querySelector("#pitch");
+
+    // Volume toggle for volume of spoken text
+    const volume = window.top?.document.querySelector("#volume");
+
+    const failedTests = window.top?.document.querySelectorAll(
+      ".test.runnable-failed"
+    ).length;
+    const retriedTests = window.top?.document.querySelectorAll(
+      ".test.runnable-passed.runnable-retried"
+    ).length;
+    const passedTests = window.top?.document.querySelectorAll(
+      ".test.runnable-passed"
+    ).length;
+    const skippedTests = window.top?.document.querySelectorAll(
+      ".test.runnable-pending"
+    ).length;
+
+    // Check test result count for passed, failed, skipped, retried
+    // If count is 1, use singular
+    function pluralizeWord(singularWord, pluralWord, count) {
+      return count > 1 ? pluralWord : singularWord;
+    }
+
+    // Calculate total spec time in mm:ss from milliseconds
+    // Taking total spec time from browser
+    // Only return seconds if minutes are less than or equal to 0
+    function specTime() {
+      const specTime = window.top?.document.querySelector(
+        '[data-cy="spec-duration"]'
+      )?.textContent;
+      const specSec = specTime?.slice(-2);
+      const specMin = specTime?.slice(0, 2);
+
+      // House single digit options
+      // Check against captured minute and second so browser speechSynthesis does not announce the zero
+      const singleDigit = [
+        "01",
+        "02",
+        "03",
+        "04",
+        "05",
+        "06",
+        "07",
+        "08",
+        "09",
+      ];
+      // If the captured minute or second matches one of the singleDigit values, remove the zero
+      const singleMin = specTime?.slice(1, 2);
+      const singleSec = specTime?.slice(-1);
+
+      // Checking for undefined time if an immediate spec error occurs
+      if (
+        specTime?.includes("ms") ||
+        specMin === undefined ||
+        specSec === undefined
+      ) {
+        return "Less than 1 second.";
+      } else if (specMin === "00") {
+        if (singleDigit.includes(specSec)) {
+          return (
+            `${singleSec}` + pluralizeWord("second", "seconds", `${singleSec}`)
+          );
+        } else {
+          return `${specSec} seconds`;
+        }
+      } else {
+        if (singleDigit.includes(specMin) && singleDigit.includes(specSec)) {
+          return (
+            `${singleMin}` +
+            pluralizeWord("minute", "minutes", `${singleMin}`) +
+            " and " +
+            `${singleSec} ` +
+            pluralizeWord("second", "seconds", `${singleSec}`)
+          );
+        } else if (
+          singleDigit.includes(specMin) &&
+          !singleDigit.includes(specSec)
+        ) {
+          return (
+            `${singleMin} ` +
+            pluralizeWord("minute", "minutes", `${singleMin}`) +
+            " and " +
+            `${specSec} seconds.`
+          );
+        } else if (
+          !singleDigit.includes(specMin) &&
+          singleDigit.includes(specSec)
+        ) {
+          return (
+            `${specMin} minutes and ${singleSec} ` +
+            pluralizeWord("second", "seconds", `${singleSec}`)
+          );
+        } else return `${specMin} minutes and ${specSec} seconds.`;
+      }
+    }
+
+    // Checking if retries are set in config
+    // If so, check the config object for the current retry number, the configured number of retries, and if current test failed
+    // If return true, do not allow the voice to activate
+    function checkRetry() {
+      if (
+        config.retries > 0 &&
+        config.retries !== config.currentRetry &&
+        config.state === "failed"
+      ) {
+        return true;
+      } else {
+        return false;
+      }
+    }
+
+    // Checking if all tests are skipped in spec file
+    // If so, announce that all spec tests are skipped
+    function checkSkipped() {
+      if (skipped && !failed && !passed) {
+        return true;
+      } else {
+        return false;
+      }
+    }
+
+    // Retrieve count of passed, failed, retried, and skipped tests
+    function retrieveTestStats() {
+      const stats = [
+        `${passedTests - retriedTests}` +
+          pluralizeWord(" test", " tests", `${passedTests - retriedTests}`) +
+          " passed.",
+        `${retriedTests}` +
+          pluralizeWord(" test", " tests", `${retriedTests}`) +
+          " passed with retries.",
+        `${failedTests}` +
+          pluralizeWord(" test", " tests", `${failedTests}`) +
+          " failed.",
+        `${skippedTests}` +
+          pluralizeWord(" test", " tests", `${skippedTests}`) +
+          " skipped.",
+      ];
+      // Filter out any zero counts and return a string for use in speechSynthesis
+      const filteredStats = stats.filter((stat) => !stat.startsWith("0"));
+      return `${filteredStats.toString()}`;
+    }
+
+    // Checking if the index of current test matches the total length of tests in the spec
+    // Checking if we are awaiting retries on final spec
+    if (currentTestIsLast && checkSkipped() === true) {
+      const message = new SpeechSynthesisUtterance(
+        "All Spec tests are skipped."
+      );
+      message.rate = rate.value;
+      message.pitch = pitch.value;
+      message.volume = volume.value;
+      speechSynthesis.speak(message);
+    }
+
+    // Before executing speechSynthesis, ensure we don't have any remaining tests to run
+    // Determine which environment variables were set and speak appropriate message
+    if (checkRetry() === false && checkSkipped() === false) {
+      // Announce spec run result and/or total time based on provided environment variable(s)
+      if (
+        Cypress.env("voiceResultType") === "simple" &&
+        !Cypress.env("voiceTime")
+      ) {
+        const message = new SpeechSynthesisUtterance(
+          `Spec ${
+            failed ? "failed." : retried ? "passed with retries." : "passed."
+          }`
+        );
+        message.rate = rate.value;
+        message.pitch = pitch.value;
+        message.volume = volume.value;
+        speechSynthesis.speak(message);
+      } else if (
+        Cypress.env("voiceTime") &&
+        !(Cypress.env("voiceResultType") === "simple") &&
+        !(Cypress.env("voiceResultType") === "detailed")
+      ) {
+        const message = new SpeechSynthesisUtterance(
+          "Total time: " + specTime()
+        );
+        message.rate = rate.value;
+        message.pitch = pitch.value;
+        message.volume = volume.value;
+        speechSynthesis.speak(message);
+      } else if (
+        Cypress.env("voiceResultType") === "detailed" &&
+        !Cypress.env("voiceTime")
+      ) {
+        const message = new SpeechSynthesisUtterance(
+          `Spec ${
+            failed
+              ? "failed: " + retrieveTestStats()
+              : retried
+              ? "passed with retries: " + retrieveTestStats()
+              : "passed: " + retrieveTestStats()
+          }`
+        );
+        message.rate = rate.value;
+        message.pitch = pitch.value;
+        message.volume = volume.value;
+        speechSynthesis.speak(message);
+      } else if (
+        Cypress.env("voiceResultType") === "simple" &&
+        Cypress.env("voiceTime")
+      ) {
+        const message = new SpeechSynthesisUtterance(
+          `Spec ${
+            failed
+              ? "failed. Total time: " + specTime()
+              : retried
+              ? "passed with retries. Total time: " + specTime()
+              : "passed. Total time: " + specTime()
+          }`
+        );
+        message.rate = rate.value;
+        message.pitch = pitch.value;
+        message.volume = volume.value;
+        speechSynthesis.speak(message);
+      } else if (
+        Cypress.env("voiceResultType") === "detailed" &&
+        Cypress.env("voiceTime")
+      ) {
+        const message = new SpeechSynthesisUtterance(
+          `Spec ${
+            failed
+              ? "failed: " + retrieveTestStats() + " Total time: " + specTime()
+              : retried
+              ? "passed with retries: " +
+                retrieveTestStats() +
+                ". Total time: " +
+                specTime()
+              : "passed: " + retrieveTestStats() + " Total time: " + specTime()
+          }`
+        );
+        message.rate = rate.value;
+        message.pitch = pitch.value;
+        message.volume = volume.value;
+        speechSynthesis.speak(message);
+      }
+    }
+  });
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "cypress-voice-plugin",
+  "version": "1.0.0",
+  "description": "Voice plugin for the Cypress Test Runner",
+  "main": "./index.js",
+  "scripts": {
+    "open": "cypress open --e2e --browser electron"
+  },
+  "keywords": [
+    "cypress",
+    "cypress.io",
+    "cypress-plugin",
+    "voice"
+  ],
+  "devDependencies": {
+    "cypress": "^13.7.1"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "author": "Dennis Bergevin",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dennisbergevin/cypress-voice-plugin.git"
+  },
+  "bugs": {
+    "url": "https://github.com/dennisbergevin/cypress-voice-plugin/issues"
+  },
+  "homepage": "https://github.com/dennisbergevin/cypress-voice-plugin#readme"
+}