@immowelt/lighthouse-ci

Lighthouse quality gate cli, for report generation and customizable threshold validation depending on project quality specification.

Specifications

• Threshold validation for lighthouse categories
• Lighthouse report generation
• Parallel validation and report generation of multiple domains

Usage

yarn global add @immowelt/lighthouse-ci

For more information use --help

lighthouse-ci --help

Configuration

You are able to define a config file which must be named lighthouse-ci.json. Lighthouse-ci search for this config in the current working dir where you execute lighthouse-ci. The config file must contains a threshold object, which refers the lighthouse categories with the threshold scores which musst be passed.

Also you are able to pass options down to lighthouse cli and chrome runner which need to be placed at options section for lighthouse options and chrome flags need to be placed at chromeFlags section.

NOTE: The passed threshold arguments to the cli overrides the config thresolds

Example:

{
  "chromeFlags": ["--headless"],
  "options": {
    "disableDeviceEmulation": true,
    "throttling": {
      "cpuSlowdownMultiplier": 1
    }
  },
  "threshold": {
    "performance": 80,
    "pwa": 80,
    "best-practices": 80,
    "accessibility": 80,
    "seo": 80
  }
}

Custom configuration file

You can also pass your own custom configuration file to the cli with the -c or --config option:

lighthouse-ci https://immowelt.de/ --config custom-config.json

Docker

We dockerized this package for a better usability in CI pipelines, you can use it locally like this:

docker pull immowelt/lighthouse-ci:latest
docker run -v /path/for/reports:/usr/src/app/lighthouse-ci immowelt/lighthouse-ci:latest https://immowelt.de/ -r

NOTE: If you want to get the generated reports locally, you need to mount a folder directly to container.

TODOs

• [x] Threshold configuration via config file
• [ ] Create node API
• [x] Dockerized images for direct usage in CI pipeline
• [x] Unit tests are missing!