2.2.11 Patch

Fixes

• Released as a patch user's fix: #39

2.2.10 Minor improvement

Minor improvement

• Addressed request for minor improvement to not show an info message Report file will not be created because user passed options.doNotCreateReportFile = true. Use HTML output of the function to create report file

v2.2.9 Bug fix for the 2.2.7 release

Major bug fix

• Release a bug fix for the issue introduced in v2.2.7

v2.2.7

Fixes

• Fixed accessibility issues in the HTML report itself, covering reported issues:
  • #29 incorrect header order
  • #19 excessive /tbody closing tag

The HTML of the report that was generated by axe-html-reporter itself had the following issues:

Now: no issues detected.

Minor UI changes

As a side effect of fixing accessibility issues (color-contrast, heading-order), the UI of the HTML report slightly changed:

v2.2.6

Chore & Maintenance

• Removed dependency on on rimraf that was pulling inflight 1.0.6
• Bumped jest-related packages to latest version

Released changes to comply with axe-core® trademark use

Minor changes to README.md and default template to comply with request #27

Added return of HTML file content and option to stop html file creation

New feature that opens more usages of this library:

From version 2.2.3, createHtmlReport(...) returns HTML content that can be additionally used for specific integrations.

If only HTML content is needed, user can pass doNotCreateReportFile: true to stop report file creation.

Suggestion on how to use this library if you don't need a report file but need only HTML it produces:

const reportHTML = createHtmlReport({
    results: rawAxeResults,
    options: {
        projectKey: 'I need only raw HTML',
        doNotCreateReportFile: true,
    },
});
console.log('reportHTML will have full content of HTML file.');
// suggestion on how to create file by yourself
if (!fs.existsSync('build/reports/saveReportHere.html')) {
    fs.mkdirSync('build/reports', {
        recursive: true,
    });
}
fs.writeFileSync('build/reports/saveReportHere.html', reportHTML);

Allow absolute path option

New optional param was introduced to allow absolute path:

outputDirPath

    createHtmlReport({
        results: 'AxeResults',
        options: {
            projectKey: 'JIRA_PROJECT_KEY',
            outputDir: 'axe-reports',
            outputDirPath: '../..',
            reportFileName: 'exampleReport.html',
        },
    });

Add raw axe tags and extended WCAG with sub-sections

Added raw tags returned from axe into details

Added subsections of WCAG, e.g WCAG 2.5.3 in the summary table

Improved Violations(Failed) section

Added To solve this violation, you need to... section and highlight for HTML and XPath:

Added anchor for the violations by violation type ID for fast navigation in case of many violations