@axe-core/watcher 3.4.0-next.89306425 → 3.4.0-next.ab2e92b9

package/dist/EventForwarder.d.ts

@@ -0,0 +1,11 @@
+declare class EventForwarder {
+    private emitter;
+    private tasks;
+    on: Cypress.PluginEvents;
+    constructor();
+    /**
+     * Forwards all the events registered so far to cypress
+     */
+    forward(on: Cypress.PluginEvents): void;
+}
+export default EventForwarder;

package/dist/EventForwarder.js

@@ -0,0 +1,57 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const eventemitter3_1 = __importDefault(require("eventemitter3"));
+class EventForwarder {
+    constructor() {
+        this.emitter = new eventemitter3_1.default();
+        this.tasks = {};
+        this.on = (action, fn) => {
+            if (action === 'task') {
+                Object.assign(this.tasks, fn);
+            }
+            else {
+                this.emitter.on(action, fn);
+            }
+        };
+    }
+    /**
+     * Forwards all the events registered so far to cypress
+     */
+    forward(on) {
+        if (Object.keys(this.tasks).length > 0) {
+            on('task', this.tasks);
+        }
+        for (const event of this.emitter.eventNames()) {
+            // We handle `before:browser:launch` event differently than others because
+            // this handler is expected to return launchOptions while other handlers
+            // do not return value.
+            if (event === 'before:browser:launch') {
+                on('before:browser:launch', (browser, launchOptions) => this.emitter
+                    .listeners(event)
+                    .reduce((prevLaunchOptions, listener) => listener(browser, prevLaunchOptions), launchOptions));
+            }
+            else {
+                /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+                on(event, (...args) => __awaiter(this, void 0, void 0, function* () {
+                    for (const listener of this.emitter.listeners(event)) {
+                        yield listener(...args);
+                    }
+                }));
+            }
+        }
+    }
+}
+exports.default = EventForwarder;
+//# sourceMappingURL=EventForwarder.js.map

package/dist/EventForwarder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventForwarder.js","sourceRoot":"","sources":["../src/EventForwarder.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAYA,kEAAwC;AAExC,MAAM,cAAc;IAKlB;QACE,IAAI,CAAC,OAAO,GAAG,IAAI,uBAAY,EAAE,CAAA;QACjC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,EAAE,EAAQ,EAAE;YAC7B,IAAI,MAAM,KAAK,MAAM,EAAE;gBACrB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;aAC9B;iBAAM;gBACL,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,EAAqC,CAAC,CAAA;aAC/D;QACH,CAAC,CAAA;IACH,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,EAAwB;QACrC,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;YACtC,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;SACvB;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE;YAC7C,0EAA0E;YAC1E,wEAAwE;YACxE,uBAAuB;YACvB,IAAI,KAAK,KAAK,uBAAuB,EAAE;gBACrC,EAAE,CACA,uBAAuB,EACvB,CACE,OAAwB,EACxB,aAA2C,EAC3C,EAAE,CACF,IAAI,CAAC,OAAO;qBACT,SAAS,CAAC,KAAK,CAAC;qBAChB,MAAM,CACL,CAAC,iBAAiB,EAAE,QAAQ,EAAE,EAAE,CAC9B,QAAQ,CACN,OAAO,EACP,iBAAiB,CACyB,EAC9C,aAAa,CACd,CACN,CAAA;aACF;iBAAM;gBACL,iEAAiE;gBACjE,EAAE,CAAC,KAAY,EAAE,CAAO,GAAG,IAAe,EAAE,EAAE;oBAC5C,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;wBACpD,MAAM,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAA;qBACxB;gBACH,CAAC,CAAA,CAAC,CAAA;aACH;SACF;IACH,CAAC;CACF;AAED,kBAAe,cAAc,CAAA"}

package/dist/cypress.js

@@ -27,6 +27,7 @@ exports.cypressConfig = void 0;
 const fs_1 = __importDefault(require("fs"));
 const util_1 = require("./util");
 const sendResultsToServer_1 = __importDefault(require("./sendResultsToServer"));
+const EventForwarder_1 = __importDefault(require("./EventForwarder"));
 /**
  * Create a Cypress config that uses the axe Watcher extension.
  *
@@ -46,8 +47,21 @@ const cypressConfig = (config) => {
             '*/__cypress/iframes/*'
         ]
     });
-    return Object.assign(Object.assign({}, userConfig), { e2e: Object.assign(Object.assign({}, userConfig.e2e), { setupNodeEvents(on, ...args) {
+    return Object.assign(Object.assign({}, userConfig), { e2e: Object.assign(Object.assign({}, userConfig.e2e), { setupNodeEvents(cypressOn, ...args) {
                 var _a, _b;
+                /**
+                 * If the user supplies `setupNodeEvents` config and registers events using `on` handler
+                 * provided by cypress, the users' custom events are overridden by ours.
+                 * @see https://github.com/dequelabs/jazzband/issues/668
+                 *
+                 * Here instead of registering the same event multiple times either by user or us,
+                 * we accumulate the events registered using `EventForwarder` which is proposed by David Sveningsson.
+                 * @see https://github.com/cypress-io/cypress/issues/5240#issuecomment-1462214696
+                 *
+                 * Afterwards, we forward the accumulated events to cypress `on` handler.
+                 */
+                const eventForwarder = new EventForwarder_1.default();
+                const on = eventForwarder.on;
                 (_b = (_a = userConfig.e2e) === null || _a === void 0 ? void 0 : _a.setupNodeEvents) === null || _b === void 0 ? void 0 : _b.call(_a, on, ...args);
                 on('before:browser:launch', (browser, launchOptions) => {
                     // We only support Chrome.
@@ -56,8 +70,21 @@ const cypressConfig = (config) => {
                             launchOptions.args.includes('--headless')) {
                             throw new util_1.HeadlessNotSupportedError('In Cypress, "--headless=new" became the default headless mode in Cypress version 12.15.0. Ensure your Cypress version is up to date and that you are not using a "before:browser:launch" configuration that adds "--headless" to launchOptions.args.');
                         }
-                        // Load the extension.
-                        launchOptions.args.push(...util_1.extensionArgs);
+                        // Load the extension. Merge extention args if provided by the user
+                        const launchOptionsArgs = [
+                            ...launchOptions.args,
+                            ...util_1.extensionArgs
+                        ].reduce((prev, arg) => {
+                            const [key, value] = arg.split('=');
+                            if (!prev[key]) {
+                                prev[key] = [];
+                            }
+                            if (value) {
+                                prev[key].push(value);
+                            }
+                            return prev;
+                        }, {});
+                        launchOptions.args = Object.entries(launchOptionsArgs).map(([key, value]) => value.length > 0 ? [key, value.join(',')].join('=') : key);
                     }
                     return launchOptions;
                 });
@@ -73,6 +100,11 @@ const cypressConfig = (config) => {
                         fs_1.default.unlinkSync(`cypress/axe-watcher/${result}`);
                     }
                 }));
+                /**
+                 * Forward the accumulated events to cypress.
+                 * For more information, see commnet on #44
+                 */
+                eventForwarder.forward(cypressOn);
             } }) });
 };
 exports.cypressConfig = cypressConfig;

package/dist/cypress.js.map

@@ -1 +1 @@
-{"version":3,"file":"cypress.js","sourceRoot":"","sources":["../src/cypress.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,4CAAmB;AACnB,iCAMe;AACf,gFAAuD;AAEvD;;;;GAIG;AAEI,MAAM,aAAa,GAAG,CAC3B,MAA6C,EACtB,EAAE;IACzB,MAAM,EAAE,GAAG,KAAoB,MAAM,EAArB,UAAU,UAAK,MAAM,EAA/B,OAAsB,CAAS,CAAA;IAErC,IAAA,qBAAc,kCACT,GAAG;QACN,sDAAsD;QACtD,OAAO,EAAE,IAAI,IACb,CAAA;IACF,IAAA,oBAAa,EAAC;QACZ,UAAU,EAAE,IAAI;QAChB,aAAa,EAAE;YACb,0BAA0B;YAC1B,4BAA4B;YAC5B,4BAA4B;YAC5B,uBAAuB;SACxB;KACF,CAAC,CAAA;IAEF,uCACK,UAAU,KACb,GAAG,kCACE,UAAU,CAAC,GAAG,KACjB,eAAe,CAAC,EAAE,EAAE,GAAG,IAAI;;gBACzB,MAAA,MAAA,UAAU,CAAC,GAAG,0CAAE,eAAe,mDAAG,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;gBAE9C,EAAE,CAAC,uBAAuB,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,EAAE;oBACrD,0BAA0B;oBAC1B,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;wBAC7B,IACE,OAAO,CAAC,UAAU;4BAClB,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EACzC;4BACA,MAAM,IAAI,gCAAyB,CACjC,sPAAsP,CACvP,CAAA;yBACF;wBAED,sBAAsB;wBACtB,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,oBAAa,CAAC,CAAA;qBAC1C;oBAED,OAAO,aAAa,CAAA;gBACtB,CAAC,CAAC,CAAA;gBAEF,wEAAwE;gBACxE,EAAE,CAAC,WAAW,EAAE,GAAS,EAAE;oBACzB,MAAM,OAAO,GAAG,YAAE;yBACf,WAAW,CAAC,qBAAqB,CAAC;yBAClC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;oBACnC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;wBAC5B,MAAM,IAAI,GAAG,YAAE,CAAC,YAAY,CAC1B,uBAAuB,MAAM,EAAE,EAC/B,MAAM,CACP,CAAA;wBACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;wBAC/B,MAAM,IAAA,6BAAmB,EAAC,MAAM,CAAC,CAAA;wBACjC,YAAE,CAAC,UAAU,CAAC,uBAAuB,MAAM,EAAE,CAAC,CAAA;qBAC/C;gBACH,CAAC,CAAA,CAAC,CAAA;YACJ,CAAC,OAEJ;AACH,CAAC,CAAA;AAhEY,QAAA,aAAa,iBAgEzB"}
+{"version":3,"file":"cypress.js","sourceRoot":"","sources":["../src/cypress.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,4CAAmB;AACnB,iCAMe;AACf,gFAAuD;AACvD,sEAA6C;AAE7C;;;;GAIG;AAEI,MAAM,aAAa,GAAG,CAC3B,MAA6C,EACtB,EAAE;IACzB,MAAM,EAAE,GAAG,KAAoB,MAAM,EAArB,UAAU,UAAK,MAAM,EAA/B,OAAsB,CAAS,CAAA;IAErC,IAAA,qBAAc,kCACT,GAAG;QACN,sDAAsD;QACtD,OAAO,EAAE,IAAI,IACb,CAAA;IACF,IAAA,oBAAa,EAAC;QACZ,UAAU,EAAE,IAAI;QAChB,aAAa,EAAE;YACb,0BAA0B;YAC1B,4BAA4B;YAC5B,4BAA4B;YAC5B,uBAAuB;SACxB;KACF,CAAC,CAAA;IAEF,uCACK,UAAU,KACb,GAAG,kCACE,UAAU,CAAC,GAAG,KACjB,eAAe,CAAC,SAAS,EAAE,GAAG,IAAI;;gBAChC;;;;;;;;;;mBAUG;gBACH,MAAM,cAAc,GAAG,IAAI,wBAAc,EAAE,CAAA;gBAC3C,MAAM,EAAE,GAAG,cAAc,CAAC,EAAE,CAAA;gBAE5B,MAAA,MAAA,UAAU,CAAC,GAAG,0CAAE,eAAe,mDAAG,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;gBAE9C,EAAE,CAAC,uBAAuB,EAAE,CAAC,OAAO,EAAE,aAAa,EAAE,EAAE;oBACrD,0BAA0B;oBAC1B,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE;wBAC7B,IACE,OAAO,CAAC,UAAU;4BAClB,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,EACzC;4BACA,MAAM,IAAI,gCAAyB,CACjC,sPAAsP,CACvP,CAAA;yBACF;wBAED,mEAAmE;wBACnE,MAAM,iBAAiB,GAAG;4BACxB,GAAG,aAAa,CAAC,IAAI;4BACrB,GAAG,oBAAa;yBACjB,CAAC,MAAM,CAAC,CAAC,IAA8B,EAAE,GAAG,EAAE,EAAE;4BAC/C,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;4BACnC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;gCACd,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;6BACf;4BAED,IAAI,KAAK,EAAE;gCACT,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;6BACtB;4BAED,OAAO,IAAI,CAAA;wBACb,CAAC,EAAE,EAAE,CAAC,CAAA;wBAEN,aAAa,CAAC,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,GAAG,CACxD,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CACf,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAC5D,CAAA;qBACF;oBAED,OAAO,aAAa,CAAA;gBACtB,CAAC,CAAC,CAAA;gBAEF,wEAAwE;gBACxE,EAAE,CAAC,WAAW,EAAE,GAAS,EAAE;oBACzB,MAAM,OAAO,GAAG,YAAE;yBACf,WAAW,CAAC,qBAAqB,CAAC;yBAClC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAA;oBACnC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;wBAC5B,MAAM,IAAI,GAAG,YAAE,CAAC,YAAY,CAC1B,uBAAuB,MAAM,EAAE,EAC/B,MAAM,CACP,CAAA;wBACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;wBAC/B,MAAM,IAAA,6BAAmB,EAAC,MAAM,CAAC,CAAA;wBACjC,YAAE,CAAC,UAAU,CAAC,uBAAuB,MAAM,EAAE,CAAC,CAAA;qBAC/C;gBACH,CAAC,CAAA,CAAC,CAAA;gBAEF;;;mBAGG;gBACH,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;YACnC,CAAC,OAEJ;AACH,CAAC,CAAA;AAvGY,QAAA,aAAa,iBAuGzB"}