feat: add @axe-core/webdriverio

.circleci/config.yml

@@ -36,6 +36,9 @@ jobs:
       - restore_cache:
           keys:
             - v1-webdriverjs-npm-{{ checksum "packages/webdriverjs/package-lock.json" }}
+      - restore_cache:
+          keys:
+            - v1-webdriverio-npm-{{ checksum "packages/webdriverio/package-lock.json" }}
       - run: npm ci
       - save_cache:
           key: v1-root-npm-{{ checksum "package-lock.json" }}
@@ -54,13 +57,18 @@ jobs:
           key: v1-webdriverjs-npm-{{ checksum "packages/webdriverjs/package-lock.json" }}
           paths:
             - packages/webdriverjs/node_modules
+      - save_cache:
+          key: v1-webdriverio-npm-{{ checksum "packages/webdriverio/package-lock.json" }}
+          paths:
+            - packages/webdriverio/node_modules
       - save_cache:
           key: v1-npm-cache-{{ .Environment.CIRCLE_SHA1 }}
           paths:
             - node_modules
             - packages/cli/node_modules
             - packages/puppeteer/node_modules
             - packages/webdriverjs/node_modules
+            - packages/webdriverio/node_modules
 
   lint:
     <<: *defaults
@@ -91,6 +99,13 @@ jobs:
       - restore_dependency_cache
       - run: npm run test --prefix=packages/webdriverjs
 
+  webdriverio:
+    <<: *defaults
+    steps: 
+      - checkout
+      - restore_dependency_cache
+      - run: npm run test --prefix=packages/webdriverio
+
 workflows:
   version: 2
   build_and_test:
@@ -108,3 +123,6 @@ workflows:
       - webdriverjs:
           requires:
             - lint
+      - webdriverio:
+          requires:
+            - lint

packages/webdriverio/.eslintrc.js

@@ -0,0 +1,15 @@
+module.exports = {
+  rules: {
+    '@typescript-eslint/no-empty-function': 'off',
+    'prefer-spread': 'off',
+    'prefer-rest-params': 'off'
+  },
+  overrides: [
+    {
+      files: 'tests/**/*.js',
+      env: {
+        jest: true
+      }
+    }
+  ]
+};

packages/webdriverio/README.md

@@ -0,0 +1,5 @@
+# @axe-core/webdriverio
+
+Provides bindings for axe with webdriverio
+
+Previous versions of this program were maintained at [dequelabs/axe-webdriverio](https://github.com/dequelabs/axe-webdriverio).

packages/webdriverio/lib/bindings.js

@@ -0,0 +1,51 @@
+module.exports = function bind(driver) {
+  const webdriver = driver;
+
+  if (
+    typeof webdriver.executeScript !== 'function' &&
+    typeof webdriver.execute === 'function'
+  ) {
+    webdriver.executeScript = function executeScript() {
+      return this.execute.apply(this, arguments);
+    }.bind(webdriver);
+  }
+
+  if (
+    typeof webdriver.executeAsyncScript !== 'function' &&
+    typeof webdriver.executeAsync === 'function'
+  ) {
+    webdriver.executeAsyncScript = function executeAsyncScript() {
+      return this.executeAsync.apply(this, arguments);
+    }.bind(webdriver);
+  }
+
+  if (
+    typeof webdriver.switchTo !== 'function' &&
+    typeof webdriver.frame === 'function'
+  ) {
+    webdriver.switchTo = function switchTo() {
+      return {
+        window: function window() {
+          return this.window.apply(this, arguments);
+        }.bind(this),
+        frame: function frame() {
+          return this.frame.apply(this, arguments);
+        }.bind(this),
+        defaultContent: function defaultContent() {
+          return this.frame.apply(this, null);
+        }.bind(this)
+      };
+    }.bind(webdriver);
+  }
+
+  if (
+    typeof webdriver.findElements !== 'function' &&
+    typeof webdriver.elements === 'function'
+  ) {
+    webdriver.findElements = function findElements(selector) {
+      return webdriver.elements(`<${selector.tagName}>`);
+    }.bind(webdriver);
+  }
+
+  return webdriver;
+};

packages/webdriverio/lib/index.d.ts

@@ -0,0 +1,4 @@
+declare module '@axe-core/webdriverio' {
+  export * from '@axe-core/webdriverjs';
+  export { AxeBuilder as AxeWebDriverIOBuilder } from '@axe-core/webdriverjs';
+}

packages/webdriverio/lib/index.js

@@ -0,0 +1,10 @@
+const AxeBuilder = require('@axe-core/webdriverjs');
+const bindings = require('./bindings');
+
+class AxeWebDriverIOBuilder extends AxeBuilder {
+  constructor(driver, source) {
+    super(bindings(driver), source);
+  }
+}
+
+module.exports = AxeWebDriverIOBuilder;