axe-cypress-a11y 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Malith Karunaratne
+
+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,135 @@
+# axe-cypress-a11y
+
+```bash
+Provides a chainable axe API for CypressIO.
+```
+
+Automated accessibility testing builder for Cypress powered by [axe-core®](https://github.com/dequelabs/axe-core), following the same patterns as other `@axe-core/xyz` packages developed by [Deque Systems, Inc](https://www.deque.com/). axe®, and axe-core® are [trademarks of Deque Systems, Inc](https://www.deque.com/legal/trademarks/). Click to find out more detaila about [Axe tools](https://www.deque.com/axe/).
+
+## Getting Started
+
+Install [Node.js](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) if you haven't already.
+
+Install Cypress: `npm install cypress `
+
+Install @axe-core/cypress: `npm install axe-cypress-a11y`
+
+## Usage
+
+This module uses a chainable API to assist in injecting, configuring, and analyzing axe with [Cypress](https://www.cypress.io/).
+
+Here is an example of a script that will drive Cypress to a page, perform an analysis, and then log results.
+
+```typescript
+import AxeBuilder from 'axe-cypress-a11y';
+
+describe('Accessibility Tests', () => {
+  it('should have no accessibility violations', () => {
+    cy.visit('/');
+    
+    new AxeBuilder()
+      .include('.main-content')
+      .exclude('.ads')
+      .withTags(['wcag2a', 'wcag2aa'])
+      .analyze()
+      .then((results) => {
+       cy.log(`Violations: ${JSON.stringify(results.violations, null, 2)}`);
+      });
+  });
+});
+
+```
+
+## API
+
+### `new AxeBuilder()`
+
+Creates a new AxeBuilder instance.
+
+### `.include(selector: string)`
+
+Add a CSS selector to include in the analysis.
+
+### `.exclude(selector: string)`
+
+Add a CSS selector to exclude from the analysis.
+
+### `.withTags(tags: string | string[])`
+
+Limit analysis to rules with specific tags (e.g., 'wcag2a', 'wcag2aa', 'wcag21a').
+
+### `.withRules(rules: string | string[])`
+
+Limit analysis to specific rule IDs.
+
+### `.disableRules(rules: string | string[])`
+
+Disable specific rules from the analysis.
+
+### `.options(options: RunOptions)`
+
+Pass custom options to axe.run().
+
+### `.configure(config: Spec)`
+
+Configure axe with custom settings.
+
+### `.analyze()`
+
+Run the accessibility analysis and return results.
+
+## Examples
+
+### Basic Usage
+
+```typescript
+new AxeBuilder()
+  .analyze()
+  .then((results) => {
+    cy.log(`Found ${results.violations.length} violations`);
+  });
+
+```
+
+### With Specific Tags
+
+```typescript
+new AxeBuilder()
+  .withTags(['wcag2a', 'wcag2aa'])
+  .analyze()
+  .then((results) => {
+    expect(results.violations).to.have.length(0);
+  });
+
+```
+
+### Exclude Elements
+
+```typescript
+new AxeBuilder()
+  .exclude('.third-party-widget')
+  .exclude('#ads')
+  .analyze()
+  .then((results) => {
+    expect(results.violations).to.have.length(0);
+  });
+
+```
+
+### Custom Configuration
+
+```typescript
+new AxeBuilder()
+  .configure({
+    rules: [{
+      id: 'color-contrast',
+      enabled: false
+    }]
+  })
+  .analyze();
+
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,117 @@
+import { RunOptions, Spec, AxeResults } from 'axe-core';
+
+/**
+ * Additional options specific to the Cypress AxeBuilder
+ */
+interface AxeBuilderOptions {
+    /**
+     * Time interval between retries in milliseconds
+     */
+    interval?: number;
+    /**
+     * Number of times to retry if violations are found
+     */
+    retries?: number;
+}
+/**
+ * Context object for specifying include/exclude selectors
+ */
+interface ContextObject {
+    include?: string[];
+    exclude?: string[];
+}
+/**
+ * Combined options for axe.run including Cypress-specific options
+ */
+type AxeRunOptions = RunOptions & AxeBuilderOptions;
+declare global {
+    namespace Cypress {
+        interface Chainable<Subject = any> {
+        }
+    }
+}
+
+/**
+ * AxeBuilder class for Cypress
+ * Provides a chainable API to configure and run axe-core accessibility tests
+ */
+declare class AxeBuilder {
+    private _includes;
+    private _excludes;
+    private _options;
+    constructor();
+    /**
+     * Add a CSS selector to the list of elements to include in analysis
+     * @param selector - CSS selector to include
+     * @returns Returns this for method chaining
+     */
+    include(selector: string): this;
+    /**
+     * Add a CSS selector to the list of elements to exclude from analysis
+     * @param selector - CSS selector to exclude
+     * @returns Returns this for method chaining
+     */
+    exclude(selector: string): this;
+    /**
+     * Specifies options to be used by axe.run
+     * Will override any other configured options, including calls to withRules() and withTags()
+     * @param options - Options object to pass to axe.run
+     * @returns Returns this for method chaining
+     */
+    options(options: AxeRunOptions): this;
+    /**
+     * Limits analysis to only those with the specified rule IDs
+     * Accepts a String of a single rule ID or an Array of multiple rule IDs
+     * @param rules - Rule ID(s) to run
+     * @returns Returns this for method chaining
+     */
+    withRules(rules: string | string[]): this;
+    /**
+     * Limits analysis to only those with the specified tags
+     * Accepts a String of a single tag or an Array of multiple tags
+     * @param tags - Tag(s) to run
+     * @returns Returns this for method chaining
+     */
+    withTags(tags: string | string[]): this;
+    /**
+     * Skips verification of the rules provided
+     * Accepts a String of a single rule ID or an Array of multiple rule IDs
+     * @param rules - Rule ID(s) to disable
+     * @returns Returns this for method chaining
+     */
+    disableRules(rules: string | string[]): this;
+    /**
+     * Set the frame testing method to "legacy mode"
+     * In this mode, axe will not open a blank page to aggregate results
+     * Use as a last resort when opening a blank page causes issues
+     * @param _legacyMode - Whether to enable legacy mode (default: true)
+     * @returns Returns this for method chaining
+     */
+    setLegacyMode(_legacyMode?: boolean): this;
+    /**
+     * Configures axe with custom configuration
+     * @param config - Configuration object to pass to axe.configure
+     * @returns Returns this for method chaining
+     */
+    configure(config: Spec): Cypress.Chainable<this>;
+    /**
+     * Performs analysis and returns results
+     * @returns Cypress chainable with axe results
+     */
+    analyze(): Cypress.Chainable<AxeResults>;
+    /**
+     * Internal method to ensure axe-core is injected into the page
+     * @private
+     * @param win - The window object
+     * @returns Promise that resolves when axe is ready
+     */
+    private _ensureAxeInjected;
+    /**
+     * Internal method to build the context object for axe.run
+     * @private
+     * @returns Context object or undefined
+     */
+    private _buildContext;
+}
+
+export { AxeBuilder, type AxeBuilderOptions, type AxeRunOptions, type ContextObject, AxeBuilder as default };

package/dist/index.d.ts

@@ -0,0 +1,117 @@
+import { RunOptions, Spec, AxeResults } from 'axe-core';
+
+/**
+ * Additional options specific to the Cypress AxeBuilder
+ */
+interface AxeBuilderOptions {
+    /**
+     * Time interval between retries in milliseconds
+     */
+    interval?: number;
+    /**
+     * Number of times to retry if violations are found
+     */
+    retries?: number;
+}
+/**
+ * Context object for specifying include/exclude selectors
+ */
+interface ContextObject {
+    include?: string[];
+    exclude?: string[];
+}
+/**
+ * Combined options for axe.run including Cypress-specific options
+ */
+type AxeRunOptions = RunOptions & AxeBuilderOptions;
+declare global {
+    namespace Cypress {
+        interface Chainable<Subject = any> {
+        }
+    }
+}
+
+/**
+ * AxeBuilder class for Cypress
+ * Provides a chainable API to configure and run axe-core accessibility tests
+ */
+declare class AxeBuilder {
+    private _includes;
+    private _excludes;
+    private _options;
+    constructor();
+    /**
+     * Add a CSS selector to the list of elements to include in analysis
+     * @param selector - CSS selector to include
+     * @returns Returns this for method chaining
+     */
+    include(selector: string): this;
+    /**
+     * Add a CSS selector to the list of elements to exclude from analysis
+     * @param selector - CSS selector to exclude
+     * @returns Returns this for method chaining
+     */
+    exclude(selector: string): this;
+    /**
+     * Specifies options to be used by axe.run
+     * Will override any other configured options, including calls to withRules() and withTags()
+     * @param options - Options object to pass to axe.run
+     * @returns Returns this for method chaining
+     */
+    options(options: AxeRunOptions): this;
+    /**
+     * Limits analysis to only those with the specified rule IDs
+     * Accepts a String of a single rule ID or an Array of multiple rule IDs
+     * @param rules - Rule ID(s) to run
+     * @returns Returns this for method chaining
+     */
+    withRules(rules: string | string[]): this;
+    /**
+     * Limits analysis to only those with the specified tags
+     * Accepts a String of a single tag or an Array of multiple tags
+     * @param tags - Tag(s) to run
+     * @returns Returns this for method chaining
+     */
+    withTags(tags: string | string[]): this;
+    /**
+     * Skips verification of the rules provided
+     * Accepts a String of a single rule ID or an Array of multiple rule IDs
+     * @param rules - Rule ID(s) to disable
+     * @returns Returns this for method chaining
+     */
+    disableRules(rules: string | string[]): this;
+    /**
+     * Set the frame testing method to "legacy mode"
+     * In this mode, axe will not open a blank page to aggregate results
+     * Use as a last resort when opening a blank page causes issues
+     * @param _legacyMode - Whether to enable legacy mode (default: true)
+     * @returns Returns this for method chaining
+     */
+    setLegacyMode(_legacyMode?: boolean): this;
+    /**
+     * Configures axe with custom configuration
+     * @param config - Configuration object to pass to axe.configure
+     * @returns Returns this for method chaining
+     */
+    configure(config: Spec): Cypress.Chainable<this>;
+    /**
+     * Performs analysis and returns results
+     * @returns Cypress chainable with axe results
+     */
+    analyze(): Cypress.Chainable<AxeResults>;
+    /**
+     * Internal method to ensure axe-core is injected into the page
+     * @private
+     * @param win - The window object
+     * @returns Promise that resolves when axe is ready
+     */
+    private _ensureAxeInjected;
+    /**
+     * Internal method to build the context object for axe.run
+     * @private
+     * @returns Context object or undefined
+     */
+    private _buildContext;
+}
+
+export { AxeBuilder, type AxeBuilderOptions, type AxeRunOptions, type ContextObject, AxeBuilder as default };

package/dist/index.js

@@ -0,0 +1,225 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  AxeBuilder: () => AxeBuilder,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/utils.ts
+function getAxeCorePath() {
+  if (typeof require.resolve === "function") {
+    return require.resolve("axe-core/axe.min.js");
+  }
+  return "node_modules/axe-core/axe.min.js";
+}
+function isAxeInjected(win) {
+  return "axe" in win && typeof win.axe === "object" && typeof win.axe.run === "function";
+}
+function injectAxeCore(win, source) {
+  win.eval(source);
+}
+function normalizeSelector(selector) {
+  return Array.isArray(selector) ? selector : [selector];
+}
+
+// src/index.ts
+var AxeBuilder = class {
+  constructor() {
+    this._includes = [];
+    this._excludes = [];
+    this._options = {};
+  }
+  /**
+   * Add a CSS selector to the list of elements to include in analysis
+   * @param selector - CSS selector to include
+   * @returns Returns this for method chaining
+   */
+  include(selector) {
+    if (selector) {
+      this._includes.push(selector);
+    }
+    return this;
+  }
+  /**
+   * Add a CSS selector to the list of elements to exclude from analysis
+   * @param selector - CSS selector to exclude
+   * @returns Returns this for method chaining
+   */
+  exclude(selector) {
+    if (selector) {
+      this._excludes.push(selector);
+    }
+    return this;
+  }
+  /**
+   * Specifies options to be used by axe.run
+   * Will override any other configured options, including calls to withRules() and withTags()
+   * @param options - Options object to pass to axe.run
+   * @returns Returns this for method chaining
+   */
+  options(options) {
+    this._options = { ...this._options, ...options };
+    return this;
+  }
+  /**
+   * Limits analysis to only those with the specified rule IDs
+   * Accepts a String of a single rule ID or an Array of multiple rule IDs
+   * @param rules - Rule ID(s) to run
+   * @returns Returns this for method chaining
+   */
+  withRules(rules) {
+    const ruleArray = normalizeSelector(rules);
+    this._options.runOnly = {
+      type: "rule",
+      values: ruleArray
+    };
+    return this;
+  }
+  /**
+   * Limits analysis to only those with the specified tags
+   * Accepts a String of a single tag or an Array of multiple tags
+   * @param tags - Tag(s) to run
+   * @returns Returns this for method chaining
+   */
+  withTags(tags) {
+    const tagArray = normalizeSelector(tags);
+    this._options.runOnly = {
+      type: "tag",
+      values: tagArray
+    };
+    return this;
+  }
+  /**
+   * Skips verification of the rules provided
+   * Accepts a String of a single rule ID or an Array of multiple rule IDs
+   * @param rules - Rule ID(s) to disable
+   * @returns Returns this for method chaining
+   */
+  disableRules(rules) {
+    const ruleArray = normalizeSelector(rules);
+    this._options.rules = this._options.rules || {};
+    ruleArray.forEach((rule) => {
+      this._options.rules[rule] = { enabled: false };
+    });
+    return this;
+  }
+  /**
+   * Set the frame testing method to "legacy mode"
+   * In this mode, axe will not open a blank page to aggregate results
+   * Use as a last resort when opening a blank page causes issues
+   * @param _legacyMode - Whether to enable legacy mode (default: true)
+   * @returns Returns this for method chaining
+   */
+  setLegacyMode(_legacyMode = true) {
+    return this;
+  }
+  /**
+   * Configures axe with custom configuration
+   * @param config - Configuration object to pass to axe.configure
+   * @returns Returns this for method chaining
+   */
+  configure(config) {
+    return cy.window({ log: false }).then((win) => {
+      return this._ensureAxeInjected(win).then(() => {
+        win.axe.configure(config);
+        return this;
+      });
+    });
+  }
+  /**
+   * Performs analysis and returns results
+   * @returns Cypress chainable with axe results
+   */
+  analyze() {
+    return cy.window({ log: false }).then((win) => {
+      return this._ensureAxeInjected(win).then(() => {
+        const context = this._buildContext();
+        const { interval, retries, ...axeOptions } = this._options;
+        let remainingRetries = retries || 0;
+        const runAxeCheck = () => {
+          return win.axe.run(context || win.document, axeOptions).then((results) => {
+            if (results.violations.length > 0 && remainingRetries > 0) {
+              remainingRetries--;
+              return new Promise((resolve) => {
+                setTimeout(() => resolve(runAxeCheck()), interval || 1e3);
+              });
+            }
+            return results;
+          });
+        };
+        return runAxeCheck();
+      });
+    });
+  }
+  /**
+   * Internal method to ensure axe-core is injected into the page
+   * @private
+   * @param win - The window object
+   * @returns Promise that resolves when axe is ready
+   */
+  _ensureAxeInjected(win) {
+    if (isAxeInjected(win)) {
+      return cy.then(() => {
+      });
+    }
+    const axePath = getAxeCorePath();
+    return cy.readFile(axePath, { log: false }).then((source) => {
+      injectAxeCore(win, source);
+    });
+  }
+  /**
+   * Internal method to build the context object for axe.run
+   * @private
+   * @returns Context object or undefined
+   */
+  _buildContext() {
+    const hasIncludes = this._includes.length > 0;
+    const hasExcludes = this._excludes.length > 0;
+    if (!hasIncludes && !hasExcludes) {
+      return void 0;
+    }
+    const context = {};
+    if (hasIncludes) {
+      context.include = this._includes;
+    }
+    if (hasExcludes) {
+      context.exclude = this._excludes;
+    }
+    return context;
+  }
+};
+var index_default = AxeBuilder;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  AxeBuilder
+});

package/dist/index.mjs

@@ -0,0 +1,195 @@
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// src/utils.ts
+function getAxeCorePath() {
+  if (typeof __require.resolve === "function") {
+    return __require.resolve("axe-core/axe.min.js");
+  }
+  return "node_modules/axe-core/axe.min.js";
+}
+function isAxeInjected(win) {
+  return "axe" in win && typeof win.axe === "object" && typeof win.axe.run === "function";
+}
+function injectAxeCore(win, source) {
+  win.eval(source);
+}
+function normalizeSelector(selector) {
+  return Array.isArray(selector) ? selector : [selector];
+}
+
+// src/index.ts
+var AxeBuilder = class {
+  constructor() {
+    this._includes = [];
+    this._excludes = [];
+    this._options = {};
+  }
+  /**
+   * Add a CSS selector to the list of elements to include in analysis
+   * @param selector - CSS selector to include
+   * @returns Returns this for method chaining
+   */
+  include(selector) {
+    if (selector) {
+      this._includes.push(selector);
+    }
+    return this;
+  }
+  /**
+   * Add a CSS selector to the list of elements to exclude from analysis
+   * @param selector - CSS selector to exclude
+   * @returns Returns this for method chaining
+   */
+  exclude(selector) {
+    if (selector) {
+      this._excludes.push(selector);
+    }
+    return this;
+  }
+  /**
+   * Specifies options to be used by axe.run
+   * Will override any other configured options, including calls to withRules() and withTags()
+   * @param options - Options object to pass to axe.run
+   * @returns Returns this for method chaining
+   */
+  options(options) {
+    this._options = { ...this._options, ...options };
+    return this;
+  }
+  /**
+   * Limits analysis to only those with the specified rule IDs
+   * Accepts a String of a single rule ID or an Array of multiple rule IDs
+   * @param rules - Rule ID(s) to run
+   * @returns Returns this for method chaining
+   */
+  withRules(rules) {
+    const ruleArray = normalizeSelector(rules);
+    this._options.runOnly = {
+      type: "rule",
+      values: ruleArray
+    };
+    return this;
+  }
+  /**
+   * Limits analysis to only those with the specified tags
+   * Accepts a String of a single tag or an Array of multiple tags
+   * @param tags - Tag(s) to run
+   * @returns Returns this for method chaining
+   */
+  withTags(tags) {
+    const tagArray = normalizeSelector(tags);
+    this._options.runOnly = {
+      type: "tag",
+      values: tagArray
+    };
+    return this;
+  }
+  /**
+   * Skips verification of the rules provided
+   * Accepts a String of a single rule ID or an Array of multiple rule IDs
+   * @param rules - Rule ID(s) to disable
+   * @returns Returns this for method chaining
+   */
+  disableRules(rules) {
+    const ruleArray = normalizeSelector(rules);
+    this._options.rules = this._options.rules || {};
+    ruleArray.forEach((rule) => {
+      this._options.rules[rule] = { enabled: false };
+    });
+    return this;
+  }
+  /**
+   * Set the frame testing method to "legacy mode"
+   * In this mode, axe will not open a blank page to aggregate results
+   * Use as a last resort when opening a blank page causes issues
+   * @param _legacyMode - Whether to enable legacy mode (default: true)
+   * @returns Returns this for method chaining
+   */
+  setLegacyMode(_legacyMode = true) {
+    return this;
+  }
+  /**
+   * Configures axe with custom configuration
+   * @param config - Configuration object to pass to axe.configure
+   * @returns Returns this for method chaining
+   */
+  configure(config) {
+    return cy.window({ log: false }).then((win) => {
+      return this._ensureAxeInjected(win).then(() => {
+        win.axe.configure(config);
+        return this;
+      });
+    });
+  }
+  /**
+   * Performs analysis and returns results
+   * @returns Cypress chainable with axe results
+   */
+  analyze() {
+    return cy.window({ log: false }).then((win) => {
+      return this._ensureAxeInjected(win).then(() => {
+        const context = this._buildContext();
+        const { interval, retries, ...axeOptions } = this._options;
+        let remainingRetries = retries || 0;
+        const runAxeCheck = () => {
+          return win.axe.run(context || win.document, axeOptions).then((results) => {
+            if (results.violations.length > 0 && remainingRetries > 0) {
+              remainingRetries--;
+              return new Promise((resolve) => {
+                setTimeout(() => resolve(runAxeCheck()), interval || 1e3);
+              });
+            }
+            return results;
+          });
+        };
+        return runAxeCheck();
+      });
+    });
+  }
+  /**
+   * Internal method to ensure axe-core is injected into the page
+   * @private
+   * @param win - The window object
+   * @returns Promise that resolves when axe is ready
+   */
+  _ensureAxeInjected(win) {
+    if (isAxeInjected(win)) {
+      return cy.then(() => {
+      });
+    }
+    const axePath = getAxeCorePath();
+    return cy.readFile(axePath, { log: false }).then((source) => {
+      injectAxeCore(win, source);
+    });
+  }
+  /**
+   * Internal method to build the context object for axe.run
+   * @private
+   * @returns Context object or undefined
+   */
+  _buildContext() {
+    const hasIncludes = this._includes.length > 0;
+    const hasExcludes = this._excludes.length > 0;
+    if (!hasIncludes && !hasExcludes) {
+      return void 0;
+    }
+    const context = {};
+    if (hasIncludes) {
+      context.include = this._includes;
+    }
+    if (hasExcludes) {
+      context.exclude = this._excludes;
+    }
+    return context;
+  }
+};
+var index_default = AxeBuilder;
+export {
+  AxeBuilder,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "axe-cypress-a11y",
+  "version": "1.0.0",
+  "description": "axe-core plugin for cypress",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "homepage": "https://github.com/malithlk/axe-core-cypress#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/malithlk/axe-core-cypress.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --dts --format esm,cjs",
+    "lint": "eslint . --cache --fix",
+    "pretest": "npm run lint",
+    "test:e2e:ci": "npx cypress run --spec 'cypress/e2e/axe-cypress.cy.ts' --headless",
+    "test": "npm run test:e2e:ci"
+  },
+  "peerDependencies": {
+    "cypress": ">=12.0.0",
+    "axe-core": ">=4.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.14.1",
+    "@typescript-eslint/eslint-plugin": "^4.8.1",
+    "@typescript-eslint/parser": "^4.8.1",
+    "axe-core": "^4.11.0",
+    "cypress": "^15.8.0",
+    "eslint": "^7.12.0",
+    "eslint-config-tamia": "^7.2.6",
+    "http-server": "^0.12.3",
+    "globals": "^16.3.0",
+    "husky": "^9.0.10",
+    "lint-staged": "^16.1.2",
+    "prettier": "^3.0.3",
+    "start-server-and-test": "^1.11.5",
+    "ts-node": "^10.9.1",
+    "tsup": "^8.0.1",
+    "typescript": "^5.6.3",
+    "@types/mocha": "^10.0.0"
+  },
+  "keywords": [
+    "a11y",
+    "cypress",
+    "testing",
+    "plugin",
+    "axe-core"
+  ],
+  "authors": [
+    {
+      "name": "Malith Karunaratne",
+      "url": "https://github.com/malithlk"
+    }
+  ],
+  "license": "MIT"
+}