Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(output): weekly command output update #1319

Merged
merged 1 commit into from
Sep 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/output/cast/cast-call

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/cheatcodes/forge-test-cheatcodes

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/cheatcodes/forge-test-cheatcodes-expectrevert

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/cheatcodes/forge-test-cheatcodes-tracing

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/cheatcodes/forge-test-simple

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/output/deps/forge-install

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/output/foundry-template/forge-build

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/output/foundry-template/forge-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions src/output/fuzz_testing/forge-test-fail-fuzz

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/fuzz_testing/forge-test-no-fuzz

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions src/output/fuzz_testing/forge-test-success-fuzz

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/output/hello_foundry/forge-build

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/hello_foundry/forge-init

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/hello_foundry/forge-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/nft_tutorial/forge-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/test_filters/forge-test-match-contract-and-test

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions src/output/test_filters/forge-test-match-path

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/reference/cli/forge.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Commands:
script Run a smart contract as a script, building transactions
that can be sent onchain
selectors Function selector utilities [aliases: se]
snapshot Create a snapshot of each test's gas usage [aliases: s]
snapshot Create a gas snapshot of each test's gas usage [aliases: s]
soldeer Soldeer dependency manager
test Run the project's tests [aliases: t]
tree Display a tree visualization of the project's dependency
Expand Down
43 changes: 18 additions & 25 deletions src/reference/cli/forge/coverage.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,45 +37,38 @@ Options:
Print help (see a summary with '-h')

Test options:
--debug <TEST_FUNCTION>
Run a test in the debugger.

The argument passed to this flag is the name of the test function you
want to run, and it works the same as --match-test.

If more than one test matches your specified criteria, you must add
additional filters until only one test is found (see --match-contract
and --match-path).
--debug [<DEPRECATED_TEST_FUNCTION_REGEX>]
Run a single test in the debugger.

The matching test will be opened in the debugger regardless of the
outcome of the test.

If the matching test is a fuzz test, then it will open the debugger on
the first failure case. If the fuzz test does not fail, it will open
the debugger on the last fuzz case.

For more fine-grained control of which fuzz case is run, see forge
run.

--flamegraph
Generate a flamegraph for a single test. Implies `--decode-internal`
Generate a flamegraph for a single test. Implies `--decode-internal`.

A flame graph is used to visualize which functions or operations
within the smart contract are consuming the most gas overall in a
sorted manner.

--flamechart
Generate a flamechart for a single test. Implies `--decode-internal`

--decode-internal [<TEST_FUNCTION>]
Whether to identify internal functions in traces.
Generate a flamechart for a single test. Implies `--decode-internal`.

If no argument is passed to this flag, it will trace internal
functions scope and decode stack parameters, but parameters stored in
memory (such as bytes or arrays) will not be decoded.
A flame chart shows the gas usage over time, illustrating when each
function is called (execution order) and how much gas it consumes at
each point in the timeline.

--decode-internal [<DEPRECATED_TEST_FUNCTION_REGEX>]
Identify internal functions in traces.

To decode memory parameters, you should pass an argument with a test
function name, similarly to --debug and --match-test.
This will trace internal functions and decode stack parameters.

If more than one test matches your specified criteria, you must add
additional filters until only one test is found (see --match-contract
and --match-path).
Parameters stored in memory (such as bytes or arrays) are currently
decoded only when a single function is matched, similarly to
`--debug`, for performance reasons.

--gas-report
Print a gas report
Expand Down
2 changes: 1 addition & 1 deletion src/reference/cli/forge/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ Wallet options - raw:
[default: 5]

--delay <DELAY>
Optional delay to apply inbetween verification attempts, in seconds
Optional delay to apply in between verification attempts, in seconds

[default: 5]

Expand Down
2 changes: 1 addition & 1 deletion src/reference/cli/forge/script.md
Original file line number Diff line number Diff line change
Expand Up @@ -471,7 +471,7 @@ Executor environment config:
[default: 5]

--delay <DELAY>
Optional delay to apply inbetween verification attempts, in seconds
Optional delay to apply in between verification attempts, in seconds

[default: 5]

Expand Down
Loading