From 498c97613862688ae7507e7fbfa2d8472cbc00b8 Mon Sep 17 00:00:00 2001 From: Daniel Harte Date: Sun, 23 Apr 2023 12:30:35 +0100 Subject: [PATCH] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 461b88f..79395ba 100644 --- a/README.md +++ b/README.md @@ -118,16 +118,16 @@ The `detailedReport` key is a boolean whether to print the more detailed report The `verbose` key is a boolean to whether to print the message `No accessibility violations detected!` when there aren't accessibility violations present in the test. For the `DefaultTerminalReporter` this is true and for the `v2 Reporter` this is false. +##### skipFailures (optional, defaults to false) + +Disables assertions based on violations and only logs violations to the console output. If you set `skipFailures` as `true`, although accessibility check is not passed, your test will not fail. It will simply print the violations in the console, but will not make the test fail. + ##### reporter (optional) 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) - -Disables assertions based on violations and only logs violations to the console output. If you set `skipFailures` as `true`, although accessibility check is not passed, your test will not fail. It will simply print the violations in the console, but will not make the test fail. - ##### options (dedicated for axe-html-reporter) Options dedicated for HTML reporter.