@fabernovel/heart-lighthouse

Description

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

Read more about the description and design of Heart.

Usage

Standalone

1. Install the package

   npm install @fabernovel/heart-lighthouse

   If you are using Yarn, npm < 7 or PNPM < 8, you also have to install Heart CLI (which is automatically installed in more recent versions of these packages managers):

   npm install @fabernovel/heart-cli

2. Start an analysis

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

   OR

   npx heart lighthouse --config config.json

   The analysis configuration follows the JSON format and has the following keys:

   {
       "url": "https://www.fabernovel.com/",
       // optional - customize Google Lighthouse
       // see https://github.com/GoogleChrome/lighthouse/blob/master/docs/configuration.md#lighthouse-configuration
       "config": {
         "extends": "lighthouse:default",
         "settings": {
           "onlyAudits": [
             "first-meaningful-paint",
             "speed-index",
             "first-cpu-idle",
             "interactive"
           ]
         }
       }
   }

Github Action

If you're using Github, you can simplify the integration of Heart in your CI scripts by using the Github Action.