Migrating cypress to v10 (#130)

* Migrating cypress to v10

This is a breaking change for v10

* Update README with correct file name

* Updating v10 and v9 specific instructions.

* Updating installation instructions for cypress-axe

* Dropping nodejs v10 and adding v16 to workflow.

.github/workflows/node.js.yml

@@ -5,25 +5,24 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node-version: [10.x, 12.x, 14.x]
+        node-version: [12.x, 14.x, 16.x]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm run build --if-present
-    - run: npm test
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test

README.md

@@ -8,17 +8,36 @@ Test accessibility with [axe-core](https://github.com/dequelabs/axe-core) in [Cy
 
 1. **Install `cypress-axe` from npm:**
 
+- For Cypress v10 install latest cypress-axe
+
 ```sh
 npm install --save-dev cypress-axe
 ```
 
-2. **Install peer dependencies:**
+- For Cypress v9 install 0.x.x
+
+```sh
+npm install --save-dev [email protected]
+```
+
+1. **Install peer dependencies:**
+
+- For Cypress v10 and above
 
 ```sh
 npm install --save-dev cypress axe-core
 ```
 
-3. **Include the commands.** Update `cypress/support/index.js` file to include the cypress-axe commands by adding:
+- For Cypress v9 and below install the specific cypress version you are using For example if you are using cypress v9.6.0
+
+```sh
+npm install --save-dev [email protected] axe-core
+```
+
+1. **Include the commands.**
+
+- For Cypress v10 and above update `cypress/support/e2e.js` file to include the cypress-axe commands by adding:
+- For Cypress v9 and below update `cypress/support/index.js` file to include the cypress-axe commands by adding:
 
 ```js
 import 'cypress-axe'
@@ -156,10 +175,8 @@ it('Has no a11y violations after button click', () => {
 
 it('Only logs a11y violations while allowing the test to pass', () => {
   // Do not fail the test when there are accessibility failures
-  cy.checkA11y(null, null, null, true);
+  cy.checkA11y(null, null, null, true)
 })
-
-
 ```
 
 #### Using the violationCallback argument

cypress.config.js

@@ -0,0 +1,9 @@
+/* eslint @typescript-eslint/no-var-requires: "off" */
+const { defineConfig } = require('cypress');
+
+module.exports = defineConfig({
+	e2e: {
+		baseUrl: 'http://localhost:8080',
+		video: false,
+	},
+});