Allow users to use any version of axe core

[aldosuwandi]

I see a couple of issues opened to upgrade axe core version, which is bundled in this library. (#36, #58)

To avoid this type of request in the future, I think we can make this awesome library more flexible by allowing users to use any axe core version.

I'm proposing to add a parameter to the injectAxe method, so users can specify their axe core source/version to overwrite the default version.

Sample scenario: Assuming the user wants to use the latest axe core

1. Install the latest axe-core

npm install -D axe-core@latest

2. Load axe.min.js and pass it into the injectAxe method

cy.readFile('node_modules/axe-core/axe.min.js', 'utf-8').then((content) => {
    cy.injectAxe(content);
    cy.checkA11y();
})

[cshouts-tasc]

It seems like npm has already solved this problem. Make axe-core a peer dependency and everything will work as intended with the developers preferred version of axe-core without any additional setup on their end.

Current consumers of the package should be able to continue using cy.injectAxe() and cy.configureAxe() in the same way they do today.

[aldosuwandi]

Currently, axe-core is bundled within this library, so unless we change the build setup, the peer dependency approach won't work.
see: #37 (comment)

The proposed solution should work if we decide to keep the bundled approach. But, if we want to unbundle it; then, peer dependency should be enough.

[sapegin]

Now I see the problem! It's bundling all dependencies, which doesn't sound like an optimal solution:

cypress-axe/package.json

Line 13 in ca7ac69

"build": "parcel build src/index.js --bundle-node-modules",

And looks like there were reasons to bundle it though I'm not sure what exactly was the problem:

#37 (comment)

[sapegin]

I've done some experiments on my project that uses cypress-axe.

When I try to use not bundled code, it fails with “fs.readFileSync is not a function”:

However, using axe.source as suggested in #38 works fine.

I suggest we make a version with axe.source without bundling and see what other problems folks may have.

[sapegin]

I've opened a pull request #69 — this works perfectly in my project. Would be great if anyone else could test it too.

[aldosuwandi]

Thanks, @sapegin. I'm not sure either why @avanslaars decided to bundle it. If we can unbundle it, that will be great.
I tried PR #69 in my project and found an issue. Please see my comment here.

[github-actions]

🎉 This issue has been resolved in version 0.9.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀