lighthouse

v11.7.0-dev.20240412

Automated auditing, performance metrics, and best practices for the web.

google chrome devtools

Readme Versions Dependencies Scripts

c8

bash core/scripts/c8.sh

fast

node ./cli/index.js --preset=desktop --throttlingMethod=provided

lint

[ "$CI" = true ] && eslint --quiet -f codeframe . || eslint .

test

yarn diff:sample-json && yarn lint --quiet && yarn unit && yarn type-check

unit

yarn unit-flow && yarn mocha

clean

 rm -r dist proto/scripts/*.json proto/scripts/*_pb2.* proto/scripts/*_pb.* proto/scripts/__pycache__ proto/scripts/*.pyc *.report.html *.report.dom.html *.report.json *.devtoolslog.json *.trace.json shared/localization/locales/*.ctc.json || true

debug

node --inspect-brk ./cli/index.js

mocha

node --loader=testdouble core/test/scripts/run-mocha-tests.js

smoke

node -r source-map-support/register cli/test/smokehouse/frontends/smokehouse-bin.js

start

yarn build-report --standalone && node ./cli/index.js

watch

yarn unit-core --watch

chrome

node core/scripts/manual-chrome-launcher.js

prepack

yarn build-report --standalone --flow --esm && yarn build-types

unit:ci

NODE_OPTIONS=--max-old-space-size=8192 npm run unit

build-lr

yarn reset-link && node --max-old-space-size=4096 ./build/build-lightrider-bundles.js

cli-unit

yarn unit-cli

coverage

yarn unit:cicoverage && c8 report --reporter html

devtools

bash core/scripts/roll-to-devtools.sh

postpack

yarn clean-types

unit-cli

yarn mocha --testMatch cli/**/*-test.js

build-all

npm-run-posix-or-windows build-all:task

changelog

conventional-changelog --config ./build/changelog-generator/index.cjs --infile changelog.md --same-file

core-unit

yarn unit-core

test-docs

yarn --cwd docs/recipes/ test

unit-core

yarn mocha core

unit-flow

bash flow-report/test/run-flow-report-tests.sh

build-pack

bash build/build-pack.sh

reset-link

(yarn unlink || true) && yarn link && yarn link lighthouse

serve-dist

cd dist && python3 -m http.server 7878

test-proto

yarn compile-proto && yarn build-proto-roundtrip

type-check

tsc --build ./tsconfig-all.json

build-types

 yarn type-check && rsync -a .tmp/tsbuildinfo/ ./ --include='*.d.ts' --include='*.d.cts' --exclude='*.map' --exclude='*.tsbuildinfo'

clean-types

git clean -xfq '*.d.ts' '*.d.cts' -e 'node_modules/' -e 'dist/' -e '.tmp/' -e '**/types/'

flow-report

yarn build-report --flow && node ./core/scripts/build-test-flow-report.js

i18n:checks

./core/scripts/i18n/assert-strings-collected.sh

test-bundle

yarn smoke --runner bundle

test-viewer

yarn unit-viewer && yarn mocha --testMatch viewer/**/*-test-pptr.js --timeout 35000

unit-report

yarn mocha --testMatch report/**/*-test.js

unit-viewer

yarn mocha --testMatch viewer/**/*-test.js

viewer-unit

yarn unit-viewer

build-report

node build/build-report-components.js && node build/build-report.js

build-viewer

node ./build/build-viewer.js

dogfood-lhci

./core/scripts/dogfood-lhci.sh

run-devtools

node core/scripts/pptr-run-devtools.js

serve-viewer

yarn serve-gh-pages

test-clients

yarn mocha --testMatch clients/**/*-test.js && yarn mocha --testMatch clients/**/*-test-pptr.js

test-lantern

bash core/scripts/test-lantern.sh

test-treemap

yarn unit-treemap && yarn mocha --testMatch treemap/**/*-test-pptr.js --timeout 35000

timing-trace

node core/scripts/generate-timing-trace.js

unit-treemap

yarn mocha --testMatch treemap/**/*-test.js

vercel-build

yarn build-sample-reports && yarn build-viewer && yarn build-treemap

build-cdt-lib

node ./build/build-cdt-lib.js

build-treemap

node ./build/build-treemap.js

compile-proto

 protoc --python_out=./ ./proto/lighthouse-result.proto && mv ./proto/*_pb2.py ./proto/scripts || (echo "❌ Install protobuf = 3.20.x to compile the proto file." && false)

deploy-viewer

yarn build-viewer --deploy

open-devtools

bash core/scripts/open-devtools.sh

serve-treemap

yarn serve-gh-pages

static-server

node cli/test/fixtures/static-server.js

test-devtools

bash core/test/devtools-tests/test-locally.sh

build-all:task

 yarn build-report && yarn build-cdt-lib && yarn build-devtools && concurrently 'yarn build-extension' 'yarn build-lr' 'yarn build-viewer' 'yarn build-treemap' 'yarn build-smokehouse-bundle' && yarn build-pack

build-devtools

 yarn reset-link && node ./build/build-bundle.js clients/devtools/devtools-entry.js dist/lighthouse-dt-bundle.js && node ./build/build-dt-report-resources.js

coverage:smoke

yarn c8 yarn smoke -j=1 && c8 report --reporter html

deploy-treemap

yarn build-treemap --deploy

serve-gh-pages

cd dist/gh-pages && python3 -m http.server 7333

build-extension

yarn build-extension-chrome && yarn build-extension-firefox

save-latest-run

./core/scripts/save-latest-run.sh

unit:cicoverage

yarn c8 --all yarn unit:ci

diff:sample-json

yarn i18n:checks && bash core/scripts/assert-golden-lhr-unchanged.sh

update:sample-json

 yarn i18n:collect-strings && node ./cli -A=./core/test/results/artifacts --config-path=./core/test/results/sample-config.js --output=json --output-path=./core/test/results/sample_v2.json && node core/scripts/cleanup-LHR-for-diff.js ./core/test/results/sample_v2.json --only-remove-timing && node ./core/scripts/update-flow-fixtures.js

build-sample-reports

yarn build-report && node build/build-sample-reports.js

i18n:collect-strings

node core/scripts/i18n/collect-strings.js

build-proto-roundtrip

mkdir -p .tmp && python3 proto/scripts/json_roundtrip_via_proto.py

computeBenchmarkIndex

./core/scripts/benchmark.js

diff:flow-sample-json

yarn i18n:collect-strings && bash core/scripts/assert-baseline-flow-result-unchanged.sh

build-all:task:windows

 yarn build-report && yarn build-cdt-lib && yarn build-extension && yarn build-devtools && yarn build-lr && yarn build-viewer && yarn build-treemap && yarn build-smokehouse-bundle