Lighthouse Badges


This package allows you to easily create Lighthouse badges for all Lighthouse categories.
Ever wanted to brag about your sites's awesome Lighthouse performance? Then this is the package for you!

Examples

$3


$3


Usage

$3

``txt
usage: lighthouse-badges [-h] [-v] [-s] [-b {flat,flat-square,plastic,for-the-badge,social}] [-o OUTPUT_PATH] [-r] -u URL

Generate gh-badges (shields.io) based on lighthouse performance.

optional arguments:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-s, --single-badge Output only one single badge averaging all lighthouse categories' scores
-b {flat,flat-square,plastic,for-the-badge,social}, --badge-style {flat,flat-square,plastic,for-the-badge,social}
Define look and feel for the badge
-o OUTPUT_PATH, --output-path OUTPUT_PATH
Define output path for artifacts
-r, --save-report Save lighthouse report as html for every supplied url

Required arguments:
-u URL, --url URL The lighthouse badge(s) will contain the score(s) of all the supplied url
`

Additionally, you can pass parameters configurations to the lighthouse process directly via environment variable path to the config file:

`bash


The variable name matters, but the path can be anything

export LIGHTHOUSE_BADGES_CONFIGURATION_PATH="~/.lhb-config.json"

"extends": "lighthouse:default" is needed, the rest is optional

cat << EOF >! $LIGHTHOUSE_BADGES_CONFIGURATION_PATH
{
"extends": "lighthouse:default",
"settings": {
"extraHeaders": {
"Authorization": "Bearer ..."
},
"onlyCategories": [
"performance",
"pwa"
],
"formFactor": "mobile"
}
}
EOF

lighthouse-badges --url https://www.youtube.com/
`

See here for more configuration examples in the official lighthouse docs.

$3

Bun >= 1.0.0 is required.

#### Option 1: bun
`bash
bun install -g lighthouse-badges
lighthouse-badges --url https://www.youtube.com/ -o test_results
`

#### Option 2: bunx
`bash
bunx lighthouse-badges --url https://www.youtube.com/ -o test_results
`

#### Option 3: Docker
`bash


May alter lighthouse results due to performance differences compared to running directly on host


docker run --rm \
-v $PWD/test_results:/home/chrome/reports \
emazzotta/lighthouse-badges \
/bin/sh -c "lighthouse-badges --url https://www.youtube.com/"
`

$3

`bash
bun run start # To run the lighthouse-badges code on google.com
``

Contributing

See contribution guideline

Sponsors

Sponsored by JetBrains

Author

Emanuele Mazzotta