chore: Justfile #14
+103
−18
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| set shell := ["bash", "-eu", "-o", "pipefail", "-c"] | ||
| set quiet # Doesn't print the command that is being run | ||
|
|
||
| COVERAGE_MIN := env_var_or_default("COVERAGE_MIN", "100") | ||
| JUST := just_executable() | ||
|
|
||
| # Runs `just help` | ||
| default: help | ||
|
|
||
| # Show available recipes | ||
| help: | ||
| {{JUST}} --list | ||
|
|
||
| # Compile contracts with `forge build` | ||
| build: | ||
| forge build | ||
|
|
||
| # Compile all contracts with `forge build --force` | ||
| build-all: | ||
| forge build --force | ||
|
|
||
| # Format Solidity sources with `forge fmt` | ||
| fmt: | ||
| forge fmt | ||
|
|
||
| # Check formatting and run `solhint` on `src`/`script`/`test` | ||
| lint: | ||
| forge fmt --check | ||
| dev/node_modules/.bin/solhint --max-warnings 0 '**/*.sol' | ||
|
|
||
| # Run Slither static analysis on `src` | ||
| slither: | ||
| dev/.venv/bin/slither src --config-file slither.config.json | ||
|
|
||
| # Run tests with `forge test` | ||
| test: | ||
| forge test --force --isolate -vvv --show-progress --gas-snapshot-check true | ||
|
Contributor
|
||
|
|
||
| # Print coverage summary (excludes `test`/`script` files) | ||
| coverage-summary: | ||
| forge coverage --no-match-coverage "^(test|script)/" --report summary | ||
|
|
||
| # Generate lcov coverage report (excludes `test`/`script` files) | ||
| coverage-lcov: | ||
| forge coverage --no-match-coverage "^(test|script)/" --report lcov | ||
|
|
||
| # Fail if total coverage is below `COVERAGE_MIN` (default `100`) | ||
| coverage-check: | ||
| {{JUST}} coverage-summary > coverage.txt | ||
| coverage="$(awk '/^\| Total/ {gsub(/%/, "", $4); print $4}' coverage.txt)"; \ | ||
|
Comment on lines
+47
to
+50
Contributor
There was a problem hiding this comment. Can we use the minimum of all four coverage values here instead of the first? |
||
| cat coverage.txt; \ | ||
| if [ -z "$coverage" ]; then echo "Failed to extract coverage percentage."; exit 1; fi; \ | ||
| awk "BEGIN {exit !($coverage >= {{COVERAGE_MIN}})}" || { echo "Coverage $coverage% is below {{COVERAGE_MIN}}%."; exit 1; }; \ | ||
| rm coverage.txt | ||
|
|
||
| # Generate gas snapshots with `forge snapshot` | ||
| snapshot: | ||
| forge snapshot --force --isolate --desc --show-progress | ||
|
|
||
| # Run build, lint, slither, test, coverage-check, snapshot | ||
| all: | ||
| {{JUST}} build | ||
| {{JUST}} lint | ||
| {{JUST}} slither | ||
| {{JUST}} coverage-check | ||
| {{JUST}} snapshot | ||
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| { | ||
| "increment - success": "43476" | ||
| } | ||
|
Comment on lines
+1
to
+3
Contributor
There was a problem hiding this comment. How was this file generated? I removed it and tried to recreate it with any commands from |
||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know that in the previous iteration of this PR you were suggested to use a
Justfile, but since we havepackage.jsonalready in use and most of these commands are one-liners, we can use package.jsonscriptsinstead, right?If a command is longer than one line or would be better on multiple lines, a script can be added like in a
scripts/directory and called by pnpm.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fair point, but in case of some longer commands (like snapshots, Solhint etc) it's easier to just write
just <target>instead of remembering the full command.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a bit annoying to use NPM scripts here because
package.jsonis in dev and so it would be something likenpm run --prefix dev whatever.The Just file looks more easy to work with than NPM scripts so I'm weakly in favor of keeping the new tool. But I'm also fine with dropping it for simplicity if we decide that.