npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

markreay-accessibility-insights-report

v0.0.6

Published

Accessibility Insights Report

Downloads

8

Readme

accessibility-insights-report

Publish axe-core accessibility scan results as self-contained HTML files in the same format as accessibility-insights-web.

Usage

Before using accessibility-insights-report, you will need to run an axe accessibility scan to produce some axe results to convert. Typically, you would do this by using an axe integration library for your favorite browser automation tool (axe-puppeteer, axe-webdriverjs, cypress-axe).

axe-sarif-converter exports a factory that can be used to create a report object and output its results as HTML.

Use it like this:

import * as Axe from 'axe';
import * as AxePuppeteer from 'axe-puppeteer';
import * as fs from 'fs';
import * as Puppeteer from 'puppeteer'
import * as util from 'util';

import { reporterFactory } from "accessibility-insights-report";

test('my accessibility test', async () => {
    // This example uses axe-puppeteer, but you can use any axe-based library
    // that outputs axe scan results in the default axe output format
    const testPage: Puppeteer.Page = /* ... set up your test page ... */;
    const axeResults: Axe.AxeResults = await new AxePuppeteer(testPage).analyze();

    // Perform the conversion
    const html = reporter.fromAxeResult(axeResults).asHTML();

    // Output the HTML file for offline viewing in any modern browser
    await util.promisify(fs.writeFile)(
        './test-results/my-accessibility-test.html',
        JSON.stringify(html),
        { encoding: 'utf8' });
}

Contributing

To contribute, please visit accessibility-insights-web for more information.

Contributor License Agreement

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.