feat: Allow to use custom axe-core location (component-driven#150)

Closes component-driven#146 component-driven#134 component-driven#84 component-driven#75

README.md

@@ -76,6 +76,21 @@ beforeEach(() => {
 })
 ```
 
+The `injectAxe` function receives an optional argument `injectOptions` of type `InjectOptions`.
+
+This `injectOptions` object can have a property `axeCorePath` of type `string`, which allows the user to specify the file from which `axe-core` will be injected.
+
+If `axeCorePath` is not provided, the function will try to resolve the path to `axe-core/axe.min.js` using the `require.resolve` function, if it is available.
+
+If `require.resolve` is not available, the default path `node_modules/axe-core/axe.min.js` will be used.
+
+```js
+beforeEach(() => {
+  cy.visit('http://localhost:9000')
+  cy.injectAxe({ axeCorePath: '<path-to-axe-core>' })
+})
+```
+
 ### cy.configureAxe
 
 #### Purpose

src/index.ts

@@ -21,11 +21,16 @@ export interface Options extends axe.RunOptions {
 	includedImpacts?: string[];
 }
 
-export const injectAxe = () => {
+export interface InjectOptions {
+	axeCorePath?: string;
+}
+
+export const injectAxe = (injectOptions?: InjectOptions) => {
 	const fileName =
-		typeof require?.resolve === 'function'
+		injectOptions?.axeCorePath ||
+		(typeof require?.resolve === 'function'
 			? require.resolve('axe-core/axe.min.js')
-			: 'node_modules/axe-core/axe.min.js';
+			: 'node_modules/axe-core/axe.min.js');
 	cy.readFile<string>(fileName).then((source) =>
 		cy.window({ log: false }).then((window) => {
 			window.eval(source);