@fabernovel/heart-lighthouse

Heart Lighthouse

Heart Lighthouse is an analysis module of Heart, which analyses URLs with Google Lighthouse.

Read more about the purpose, design and general installation of Heart.

Installation

1. Install Google Chrome, as Google Lighthouse relies on it to analyze a web page

2. Add the package to your project:

   npm install @fabernovel/heart-lighthouse
   

3. Add Heart CLI if you have not already installed it. It is a peer-dependency of heart-lighthouse

   npm install @fabernovel/heart-cli
   

Usage

Analysis setup

The analysis setup must use the JSON format with a url key.

Simple

Using Heart CLI, to start a Google Lighthouse analysis of https://www.fabernovel.com looks like this:

npx heart lighthouse --inline '{"url":"https://heart.fabernovel.com"}'

Advanced

You can change the default Google Lighthouse configuration with the config key. Populate it with the values described in their documentation:

lighthouse.json:

{
  "url": "https://heart.fabernovel.com",
  "config": {
    "extends": "lighthouse:default",
    "settings": {
      "onlyAudits": [
        "first-meaningful-paint",
        "speed-index",
        "first-cpu-idle",
        "interactive"
      ]
    }
  }
}

npx heart lighthouse --file lighthouse.json