feat(cli): replace gas report #1049
Merged
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
|
holic
commented
Jun 19, 2023
| @@ -23,6 +23,12 @@ jobs: | |||
| - name: Run tests | |||
| run: pnpm test | |||
|
|
|||
| - name: Generate gas reports | |||
| run: pnpm gas-report | |||
There was a problem hiding this comment.
This is moved here since the gas report runs best if the tests are already compiled/cached.
alvrs
approved these changes
Jun 20, 2023
There was a problem hiding this comment.
lgtm! We should add a note about this being a breaking change for existing users of the gas-report cli to the commit message. Something like:
BREAKING CHANGE:
- make your test files extend `GasReporter` (imported from `@latticexyz/std-contracts/src/test/GasReporter.sol`)
- replace `!gasreport <message>` with `startGasReport(<message>);` and add `endGasReport()` at the end of the code block to be measured
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.
Replaces our slow and error prone approach of generating new test files from magic comments with a Solidity-native approach, inspired by the approach in nomoixyz/vulcan#104.
This hopefully means we can re-open #771 and easier to do #667 (since gas report is now ~just a test output parser)