https://github.com/kavrillon/web-q5y

Perform web audits via Jest.
https://github.com/kavrillon/web-q5y

a11y audit e2e performance puppeteer seo

Last synced: about 3 hours ago
JSON representation

Perform web audits via Jest.

• Host: GitHub
• URL: https://github.com/kavrillon/web-q5y
• Owner: kavrillon
• Created: 2019-11-11T10:26:16.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-09-21T14:45:03.000Z (over 3 years ago)
• Last Synced: 2024-04-24T21:20:42.160Z (10 months ago)
• Topics: a11y, audit, e2e, performance, puppeteer, seo
• Language: JavaScript
• Homepage:
• Size: 1.05 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Web Q5Y Checker

Testing: SEO audit, Lighthouse audit with Jest

## Installation

1. `npm add @kavrillon/web-q5y` or `yarn add @kavrillon/web-q5y`

2. Add the `test:e2e` command in your `package.json`:

```

  "scripts": {

    ...

    "test:e2e": "JEST_PUPPETEER_CONFIG=node_modules/@kavrillon/web-q5y/jest-puppeteer.config.js jest test --runInBand --detectOpenHandles --verbose --config=node_modules/@kavrillon/web-q5y/jest.config.js"

  },

```

3. Create a conf file at the root of your app named `.q5yrc`, and copy/paste the content of the `sample.q5yrc` file. This file will contain all your testing conf.

### Testing Conf

- `command`: the command that will launch the server. If not provided, no server will be launched, it will only listen for the given url.

- `loadedSelector`: if provided, we will wait for this selector existence before launching tests. It is useful for testing SPAs, as the content is generated clientside.

- `url`: the host url to test

- `port`: the port to test

- `routes`: array of the routes to test (do not put the host nor the port)

- `thresholds`: for Lighthouse audit, minimum percentage to make test pass (for each category).

### Tests done

#### SEO Audit

Check presence of meta title, description, headings, etc.

#### Lighthouse Audit

Pass a Lighthouse Audit via Puppeteer (a11y, perfs, best practises, seo, page speed, pwa, etc.)