Skip to content

Commit

Permalink
fix: update dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
sf-v committed Dec 9, 2024
1 parent 6759f89 commit 143324a
Show file tree
Hide file tree
Showing 61 changed files with 13,005 additions and 6,472 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,7 @@ that allows you to monitor your benchmarks over the time with each commit.

## Getting Started

Ready to jump in? We recommend starting with [The "Best" Manifesto][best
introduction] first, and then once you have a solid understanding of how
Ready to jump in? We recommend starting with [The "Best" Manifesto][best introduction] first, and then once you have a solid understanding of how
Best works, checking out the [Developer Guide][getting started] to read
about how to get started!

Expand Down
2 changes: 1 addition & 1 deletion babel.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module.exports = {
presets: ['@babel/preset-typescript'],
plugins: [
'@babel/plugin-proposal-class-properties',
'@babel/transform-modules-commonjs',
'@babel/plugin-syntax-dynamic-import',
'@babel/transform-modules-commonjs',
],
};
50 changes: 25 additions & 25 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@
[Learn the fundamentals of Best](introduction/) and begin accurately
measuring your code's performance.

* Easy to Write
- Easy to Write

Benchmarks are easy to write with a simple set of familiar primitives
so you don't have to learn a whole new framework.
Benchmarks are easy to write with a simple set of familiar primitives
so you don't have to learn a whole new framework.

* Anywhere and Anytime
- Anywhere and Anytime

You can run, compare, and diff any change locally and on dedicated
hardware. This lets you compare any version in any browser you desire.
You can run, compare, and diff any change locally and on dedicated
hardware. This lets you compare any version in any browser you desire.

* Simple Automation
- Simple Automation

Best allows you to set up one set of shared hardware so individual
teams don't have to maintain their own infrastructure.
Best allows you to set up one set of shared hardware so individual
teams don't have to maintain their own infrastructure.

## Getting Started with Best

Expand All @@ -32,18 +32,18 @@ started!
import fib from '../fib';

describe('js-execution', () => {
benchmark('fibonacci 15', () => {
run(() => {
return fib(15);
})
})

benchmark('fibonacci 38', () => {
run(() => {
return fib(38);
})
})
})
benchmark('fibonacci 15', () => {
run(() => {
return fib(15);
});
});

benchmark('fibonacci 38', () => {
run(() => {
return fib(38);
});
});
});
```

## Why Use Best?
Expand All @@ -64,11 +64,11 @@ Learn more in [Setting Up a Best Hub](running-remotely/).
Best comes with the ability to measure all the metrics you might want
to know. Learn more in [Expressive Metrics](introduction/#expressive-metrics).

* `aggregate` - The total time your benchmark took to run.
* `script` - The time it took to evaluate your benchmark code.
* `paint` - If your benchmark involves the DOM, Best measures how much
- `aggregate` - The total time your benchmark took to run.
- `script` - The time it took to evaluate your benchmark code.
- `paint` - If your benchmark involves the DOM, Best measures how much
time the browser spends on painting.
* `layout` - If your benchmark involves the DOM, Best measures how much
- `layout` - If your benchmark involves the DOM, Best measures how much
time the browser spends on layouts.

![Best Example Run](_assets/lwc_example_terminal.png)
Expand Down
7,839 changes: 7,838 additions & 1 deletion docs/_assets/scripts.js

Large diffs are not rendered by default.

949 changes: 948 additions & 1 deletion docs/_assets/styles.css

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
* [Introduction](/introduction/)
* [Getting Started](/getting-started/)
* [Running Remotely](/running-remotely/)
* [Continuous Integration](/ci/)
* [GitHub Integration](/github-integration/)
* [Frontend](/frontend/)
* [Configuration](/configuration/)
- [Introduction](/introduction/)
- [Getting Started](/getting-started/)
- [Running Remotely](/running-remotely/)
- [Continuous Integration](/ci/)
- [GitHub Integration](/github-integration/)
- [Frontend](/frontend/)
- [Configuration](/configuration/)
8 changes: 4 additions & 4 deletions docs/ci/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@ commit from the PR. The `--gitIntegration` flag causes Best to post the
results on the pull request on GitHub.

?> To guarantee reproducible results, we **highly** recommend using
a remote runner for your benchmarks. Check out the guide on [running
remotely](../running-remotely/).
a remote runner for your benchmarks. Check out the guide on [running
remotely](../running-remotely/).

## External Storage

Expand All @@ -68,12 +68,12 @@ storing the artifacts on AWS.
To use an external storage provider, pass the `--externalStorage` flag:

```sh
best --compareStats ${BASE_COMMIT} ${TARGET_COMMIT}
best --compareStats ${BASE_COMMIT} ${TARGET_COMMIT}
```

You must also set the `AWS_BUCKET_NAME` environment variable so Best
knows where to find your artifacts. The bucket must be publicly
accessible so that Best can read and write into it.

!> To use a [remote runner](../running-remotely) to run your benchmarks
you must use external storage.
you must use external storage.
6 changes: 3 additions & 3 deletions docs/configuration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
Best is highly configurable through command-line arguments,
the Best configuration file, and environment variables.

* [Command Line Arguments](#command-line-arguments)
* [Best Configuration File](#best-configuration-file)
* [Environment Variables](#environment-variables)
- [Command Line Arguments](#command-line-arguments)
- [Best Configuration File](#best-configuration-file)
- [Environment Variables](#environment-variables)

## Command Line Arguments

Expand Down
4 changes: 2 additions & 2 deletions docs/frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ Check out the live demo to see a front end showing Best's own
examples.

?> To use the front end, [configure](#configuring-apidatabase) your
`best.config.js` to use a hosted API database to store the result
summaries.
`best.config.js` to use a hosted API database to store the result
summaries.

## Manual Installation

Expand Down
10 changes: 5 additions & 5 deletions docs/github-integration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ We recommend naming the App `Best - [organization name]`.

The GitHub App requires these permissions:

* **Checks**: Read/Write
* **Issues**: Read/Write
* **Pull Requests**: Read/Write
- **Checks**: Read/Write
- **Issues**: Read/Write
- **Pull Requests**: Read/Write

Set these environment variables so Best can authenticate and interact
with your GitHub App. We recommended setting these environment variables
Expand All @@ -30,7 +30,7 @@ GIT_APP_CERT_BASE64=base64_encoded_version_of_private_key
Set either `GIT_APP_CERT_PATH` or `GIT_APP_CERT_BASE64`.

?> To enable GitHub integration for the front end, set these environment
variables on your front end instance as well.
variables on your front end instance as well.

To enable comments on pull requests from your CI workflow, set the
environment variable `PULL_REQUEST` with the URL of the pull request.
Expand All @@ -42,7 +42,7 @@ flag. This flag tells Best to create a GitHub Check and comment if there
is a significant performance change.

?> You must specify the `--compareStats` flag to use `--gitIntegration`
because Best reports meaningful differences _across commits_.
because Best reports meaningful differences _across commits_.

## Configuration

Expand Down
20 changes: 10 additions & 10 deletions docs/introduction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ learn how Best can help you create performant code and, most important,
keep it performant over time.

?> The name of the project _Best_ was inspired by _Jest_ - changing
the _"J"_ to a _"B"_ for _"benchmarks."_ The idea was that running
benchmarks and doing perf testing should be as easy as unit testing.
the _"J"_ to a _"B"_ for _"benchmarks."_ The idea was that running
benchmarks and doing perf testing should be as easy as unit testing.

## The Best Manifesto

Expand Down Expand Up @@ -68,8 +68,8 @@ Agents, of the same and different environments, to deliver results
as quickly as possible.

!> Multiple teams and users may use a single Best Hub. This avoids
teams running their own performance infrastructure. Scale the Hub
up by adding as many Agents as you need.
teams running their own performance infrastructure. Scale the Hub
up by adding as many Agents as you need.

Once you have a Best Hub running, you get to take full advantage of
everything Best has to offer. Read more about this in [Running
Expand All @@ -90,23 +90,23 @@ consistent snapshots of your code's performance overtime.

Best helps you understand your code's performance with its many metrics.

* `aggregate` The total time your benchmark took to run. If you look at
- `aggregate` The total time your benchmark took to run. If you look at
one metric it should be this one.

* `script` The time it took to evaluate your benchmark code. This is
- `script` The time it took to evaluate your benchmark code. This is
useful to confirm your benchmark code is running as quickly as you
expect.

* `paint` If your benchmark involves the DOM, Best measures how much
- `paint` If your benchmark involves the DOM, Best measures how much
time the browser spends on painting. This is useful to make your UI
code paths more efficient.

* `layout` If your benchmark involves the DOM, Best measures how much
- `layout` If your benchmark involves the DOM, Best measures how much
time the browser spends on layouts. This gives you a picture of how
complex of DOM structure you are using.

!> The `paint` and `layout` metrics are only available when using
`runner-headless` because Best gets these directly from Chrome
Dev Tools tracing.
`runner-headless` because Best gets these directly from Chrome
Dev Tools tracing.

[Rollup]: https://rollupjs.org/
18 changes: 9 additions & 9 deletions docs/package.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"devDependencies": {
"csso-cli": "4.0.2",
"docsify": "4.13.1",
"docsify-cli": "4.4.4",
"docsify-copy-code": "2.1.1",
"docsify-sidebar-collapse": "1.3.5",
"docsify-toc": "1.1.0",
"html-minifier-terser": "7.2.0",
"prismjs": "1.29.0",
"terser": "5.30.3"
"csso-cli": "^4.0.2",
"docsify": "^4.13.1",
"docsify-cli": "^4.4.4",
"docsify-copy-code": "^3.0.0",
"docsify-sidebar-collapse": "^1.3.5",
"docsify-toc": "^1.1.0",
"html-minifier-terser": "^7.2.0",
"prismjs": "^1.29.0",
"terser": "^5.36.0"
},
"name": "@best/docs",
"private": true,
Expand Down
10 changes: 5 additions & 5 deletions docs/running-remotely/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Agents run performance benchmarks. Deploy them to dedicated
hardware with stable environments so the results are consistent.

!> While dedicated hardware can be expensive or hard to manage,
we **strongly** recommend running Best Agents on dedicated
hardware. Dedicated hardware means that there won't be any
other processes on the machine influencing your benchmarks.
This is key to a reproducible and reliable measurement.
we **strongly** recommend running Best Agents on dedicated
hardware. Dedicated hardware means that there won't be any
other processes on the machine influencing your benchmarks.
This is key to a reproducible and reliable measurement.

### Provisioning an Agent

Expand All @@ -25,7 +25,7 @@ The easiest way to set up an Agent is to click the button below.
It creates a Heroku app with everything you need.

?> To use a Best Hub, provision the Hub first and then come back
and press the button to configure your Agent to work with your Hub.
and press the button to configure your Agent to work with your Hub.

[![Deploy Best Agent](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/salesforce/best-heroku-deploy/tree/agent)

Expand Down
Loading

0 comments on commit 143324a

Please sign in to comment.