@codechecks/lighthouse-keeper NPM

Install

npm install --save-dev @codechecks/lighthouse-keeper

Usage

Are you new to codechecks? Check out getting started guide (it's simple)!

Add to your codechecks.yml file:

checks:
  - name: lighthouse-keeper
    options:
      # just provide path to your build
      buildPath: ./build
      # or full url
      # url: https://google.com
      # you can specify minScores and automatically fail builds
      minScores:
        performance: 90
  # ...

API

lighthouseKeeper(options: Options): Promise\

options

interface Options {
  url?: string;
  buildPath?: string;
  minScores?: Dictionary<number>;
}

url

optional string Provide URL that lighthouse will be ran against. url OR buildPath MUST be provided.

buildPath

optional string Provide relative path to directory with build. It will be served using http-server package and lighthouse will be ran against it. url OR buildPath MUST be provided.