feat: add time options to set loading network speed, latency and message #384
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ork speed, latency and loading message for every check
ai
reviewed
Jan 30, 2025
README.md
Outdated
| @@ -14,7 +14,7 @@ if the cost exceeds the limit. | |||
| that use their own bundler or small npm libraries with many files. | |||
| * Can calculate **the time** it would take a browser | |||
| to download and **execute** your JS. Time is a much more accurate | |||
| and understandable metric compared to the size in bytes. | |||
| and understandable metric compared to the size in bytes. Additionally, you can customize it via config for every check with network speed, latency and so on. | |||
There was a problem hiding this comment.
Looks good but we need more examples in docs
There was a problem hiding this comment.
Thank you for the suggestion. I've added the documentation to the time plugin and left the reference in the root readme.
|
I am going to FOSDEM on this weekend and will be able to review it only next week |
ai
reviewed
Jan 30, 2025
README.md
Outdated
| @@ -14,7 +14,7 @@ if the cost exceeds the limit. | |||
| that use their own bundler or small npm libraries with many files. | |||
| * Can calculate **the time** it would take a browser | |||
| to download and **execute** your JS. Time is a much more accurate | |||
| and understandable metric compared to the size in bytes. | |||
| and understandable metric compared to the size in bytes. Additionally, you can [customize time plugin] via config for every check with network speed, latency and so on. | |||
There was a problem hiding this comment.
Suggested change
| and understandable metric compared to the size in bytes. Additionally, you can [customize time plugin] via config for every check with network speed, latency and so on. | |
| and understandable metric compared to the size in bytes. | |
| Additionally, you can [customize time plugin] via config | |
| for every check with network speed, latency and so on. |
There was a problem hiding this comment.
Limited to 80 columns, thanks!
ai
reviewed
Jan 30, 2025
packages/time/README.md
Outdated
| @@ -3,7 +3,44 @@ | |||
| The plugin for [Size Limit] to track JS download and execution time by [estimo] | |||
| and Puppeter. | |||
|
|
|||
| See Size Limit docs for more details. | |||
| ## Custom options | |||
There was a problem hiding this comment.
Let’s replace it to Customize Network Speed (capitalized)
There was a problem hiding this comment.
Updated, thank you!
ai
reviewed
Jan 30, 2025
packages/time/README.md
Outdated
| See Size Limit docs for more details. | ||
| ## Custom options | ||
|
|
||
| By default, Size Limit measures the loading time of your files using a slow 3G network (50 kB/s) without latency. You can customize these settings for each check by modifying your Size Limit configuration: |
There was a problem hiding this comment.
Okay, I updated my workspace settings to limit it to 80 columns and updated the doc.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces a new time field for check configuration to customize
@size-limit/timeplugin loading time with such options as network speed, latency, and message.Resolves #325
Further enhancement: