Need Package Maintenance

    @daniel.husar/a11y-static-report

    1.0.1 • Public • Published

    a11y-static-report Build Status

    Run accessibility report on static pages via axe-core

    demo.gif

    How it works

    It starts the static webserver and look up for all html files inside of it. From the html files we generate routes and use them as input for a11y-report.

    Install

    yarn add --dev @daniel.husar/a11y-static-report

    or

    npm install --dev @daniel.husar/a11y-static-report

    Usage

    import a11yStaticReport from '@daniel.husar/a11y-static-report';
    
    (async () => {
      await a11yStaticReport({
        folder: 'public',
      });
    })();

    API

    a11yStaticReport(config)

    Prints accessibility report with logger function and returns promise that resolves for not errors or reject if there is any error.

    config

    Property Type Default Description
    port number 9001 Port on which static server will start.
    folder string public Folder with static files to serve.
    excludeFiles array<string∣RegExp> [] Array of files to ignore. Could be string or RegExp. Example ['blog/index.html', /^de\/blog/]
    debug boolean false Prints debug messages.

    Every other option that you pass, will be forwarded into a11y-report.

    Cli

    yarn add --dev @daniel.husar/a11y-static-report
    yarn a11y-static-report --folder=out

    For more complex config options you can use .a11yrc file in the root of your project:

    .a11yrc

    module.exports = {
      port: 9001,
      folder: 'out',
      reporter: 'simple'
    }

    License

    MIT

    Install

    npm i @daniel.husar/a11y-static-report

    DownloadsWeekly Downloads

    5

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    2.28 MB

    Total Files

    13

    Last publish

    Collaborators

    • efrafa