Need help with lighthouse-badges?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

emazzotta
148 Stars 21 Forks MIT License 726 Commits 0 Opened issues

Description

🚦Generate badges (shields.io) based on Lighthouse performance.

Services available

!
?

Need anything else?

Contributors list

# 55,608
HTML
flowcha...
travis
ESLint
689 commits
# 176
nextjs
postman...
graphql...
angular...
5 commits
# 748
GitHub
rust-la...
wechat-...
herokua...
1 commit
# 42,933
xslt
laravel...
api-fra...
scrapy-...
1 commit

Build Status Code Coverage NPM downloads NPM version License

Lighthouse Badges

Lighthouse

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

All Badges

Lighthouse Accessibility Badge Lighthouse Best Practices Badge Lighthouse Performance Badge Lighthouse PWA Badge Lighthouse SEO Badge

Single Badge

Lighthouse

Usage

Help

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


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,popout,popout-square,social}, --badge-style {flat,flat-square,plastic,for-the-badge,popout,popout-square,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 URLS [URLS ...], --urls URLS [URLS ...] The lighthouse badge(s) will contain the respective average score(s) of all the urls supplied, combined

Additionally you can pass parameters to the lighthouse process directly via environment variable:

# This will pass '--preset=desktop' to the lighthouse process
export LIGHTHOUSE_BADGES_PARAMS="--preset=desktop"
lighthouse-badges --urls https://www.youtube.com/

Run

Hint: node versions below 12 are not supported.

Option 1: npm

npm i -g lighthouse-badges
lighthouse-badges --urls https://www.youtube.com/ https://www.youtube.com/feed/trending -o test_results

Option 2: npx

npx lighthouse-badges --urls https://www.youtube.com/ https://www.youtube.com/feed/trending -o test_results

Option 3: Docker

# Warning, the docker version may alter the lighthouse results
docker run --rm \
    -v $PWD/test_results:/home/chrome/reports \
    emazzotta/lighthouse-badges \
    /bin/sh -c "lighthouse-badges --urls https://www.youtube.com/ https://www.youtube.com/feed/trending"

Contributing

See contribution guideline

Sponsors

Sponsored by JetBrains

Jetbrains Logo

Author

Emanuele Mazzotta

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.