Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(perf-benchmarks): say how long things take #5167

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(perf-benchmarks): say how long things take #5167

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7f7c487
docs(perf-benchmarks): say how long things take
wjhsf Jan 24, 2025
a6da552
chore: yarn format
wjhsf Jan 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions packages/@lwc/perf-benchmarks/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ cd packages/@lwc/perf-benchmarks
../../../node_modules/.bin/tach --config dist/__benchmarks__/path/to/tachometer.json
```

> [!TIP]
> Running all of the benchmarks will take multiple hours. Let it run overnight!

## Manual testing

When the benchmark is not working, the best way to debug it locally is to load its HTML file and inspect it in the Chrome DevTools. After building, you can run:
Expand Down Expand Up @@ -84,3 +87,6 @@ This package also supports [Best](https://bestjs.dev) as a benchmark runner. To
Or for CI:

yarn test:performance:best:ci

> [!TIP]
> Best tests only take a few dozen minutes. Take a break!