axe-playwright 1.2.1 → 1.2.3

package/README.md

@@ -120,7 +120,9 @@ The `verbose` key is a boolean to whether to print the message `No accessibility
 
 ##### reporter (optional)
 
-A class instance that implements the `Reporter` interface or values `default` and `v2`. Custom reporter instances can be supplied to override default reporting behaviour dictated by `DefaultTerminalReporter` set by the value `default`. `v2` is the new TerminalReporter inspired by the reports from [jest-axe](https://github.com/nickcolley/jest-axe).
+A class instance that implements the `Reporter` interface or values `default`, `v2` and `html`. Custom reporter instances can be supplied to override default reporting behaviour dictated by `DefaultTerminalReporter` set by the value `default`. `v2` is the new TerminalReporter inspired by the reports from [jest-axe](https://github.com/nickcolley/jest-axe). `html` reporter will generate external HTML file.
+
+Note! `html` reporter will disable printed to logs violations.
 
 ##### skipFailures (optional, defaults to false)
 

package/dist/index.d.ts

@@ -52,5 +52,5 @@ export declare const reportViolations: (violations: Result[], reporter: Reporter
  * @param reporter
  * @param options
  */
-export declare const checkA11y: (page: Page, context?: ElementContext | undefined, axeOptions?: AxeOptions | undefined, skipFailures?: boolean, reporter?: Reporter | 'default' | 'v2', options?: Options | undefined) => Promise<void>;
+export declare const checkA11y: (page: Page, context?: ElementContext | undefined, axeOptions?: AxeOptions | undefined, skipFailures?: boolean, reporter?: Reporter | 'default' | 'html' | 'v2', options?: Options | undefined) => Promise<void>;
 export { DefaultTerminalReporter };

package/dist/index.js

@@ -105,11 +105,6 @@ exports.reportViolations = reportViolations;
 const checkA11y = (page, context = undefined, axeOptions = undefined, skipFailures = false, reporter = 'default', options = undefined) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b, _c;
     const violations = yield (0, exports.getViolations)(page, context, axeOptions === null || axeOptions === void 0 ? void 0 : axeOptions.axeOptions);
-    if (violations.length > 0) {
-        yield (0, axe_html_reporter_1.createHtmlReport)({ results: { violations }, options });
-    }
-    else
-        console.log("There were no violations to save in report");
     const impactedViolations = (0, utils_1.getImpactedViolations)(violations, axeOptions === null || axeOptions === void 0 ? void 0 : axeOptions.includedImpacts);
     let reporterWithOptions;
     if (reporter === 'default') {
@@ -118,11 +113,19 @@ const checkA11y = (page, context = undefined, axeOptions = undefined, skipFailur
     else if (reporter === 'v2') {
         reporterWithOptions = new terminalReporterV2_1.default((_c = axeOptions === null || axeOptions === void 0 ? void 0 : axeOptions.verbose) !== null && _c !== void 0 ? _c : false);
     }
+    else if (reporter === 'html') {
+        if (violations.length > 0) {
+            yield (0, axe_html_reporter_1.createHtmlReport)({ results: { violations }, options });
+        }
+        else
+            console.log("There were no violations to save in report");
+    }
     else {
         reporterWithOptions = reporter;
     }
-    yield (0, exports.reportViolations)(impactedViolations, reporterWithOptions);
-    if (reporter !== 'v2')
+    if (reporter !== 'html')
+        yield (0, exports.reportViolations)(impactedViolations, reporterWithOptions);
+    if (reporter === 'v2' || reporter !== 'html')
         (0, utils_1.testResultDependsOnViolations)(impactedViolations, skipFailures);
 });
 exports.checkA11y = checkA11y;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-playwright",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Custom Playwright commands to inject axe-core and test for a11y",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",