| 1 | # React Benchmarking |
| 2 | |
| 3 | ## Commands |
| 4 | |
| 5 | In most cases, the only two commands you might want to use are: |
| 6 | |
| 7 | - `yarn start` |
| 8 | - `yarn --cwd=../../ build react/index,react-dom/index --type=UMD_PROD && yarn start --skip-build` |
| 9 | |
| 10 | The first command will run benchmarks with all the default settings. A local and remote build will occur on React and ReactDOM UMD bundles, both local and remote repos will be run against all benchmarks. |
| 11 | |
| 12 | The second command will run all benchmarks but skip the build process. This is useful for when doing local performance tweaking and the remote repo has already had its bundles built. Both local and remote repos will be run against all benchmarks with this command too. |
| 13 | |
| 14 | The other commands are as follows: |
| 15 | |
| 16 | ```bash |
| 17 | # will compare local repo vs remote merge base repo |
| 18 | yarn start |
| 19 | |
| 20 | # will compare local repo vs remote merge base repo |
| 21 | # this can significantly improve bench times due to no build |
| 22 | yarn start --skip-build |
| 23 | |
| 24 | # will only build and run local repo against benchmarks (no remote values will be shown) |
| 25 | yarn start --local |
| 26 | |
| 27 | # will only build and run remote merge base repo against benchmarks (no local values will be shown) |
| 28 | yarn start --remote |
| 29 | |
| 30 | # will only build and run remote main repo against benchmarks |
| 31 | yarn start --remote=main |
| 32 | |
| 33 | # same as "yarn start" |
| 34 | yarn start --remote --local |
| 35 | |
| 36 | # runs benchmarks with Chrome in headless mode |
| 37 | yarn start --headless |
| 38 | |
| 39 | # runs only specific string matching benchmarks |
| 40 | yarn start --benchmark=hacker |
| 41 | ``` |