update command output (#1258)

foundry-rs · Aug 11, 2024 · 44853ec · 44853ec
1 parent 7c8eda2
commit 44853ec
Show file tree

Hide file tree

Showing 20 changed files with 83 additions and 50 deletions.
diff --git a/src/output/cast/cast-call b/src/output/cast/cast-call
diff --git a/src/output/cheatcodes/forge-test-cheatcodes b/src/output/cheatcodes/forge-test-cheatcodes
diff --git a/src/output/cheatcodes/forge-test-cheatcodes-expectrevert b/src/output/cheatcodes/forge-test-cheatcodes-expectrevert
diff --git a/src/output/cheatcodes/forge-test-cheatcodes-tracing b/src/output/cheatcodes/forge-test-cheatcodes-tracing
diff --git a/src/output/cheatcodes/forge-test-simple b/src/output/cheatcodes/forge-test-simple
diff --git a/src/output/deps/forge-install b/src/output/deps/forge-install
diff --git a/src/output/foundry-template/forge-build b/src/output/foundry-template/forge-build
diff --git a/src/output/foundry-template/forge-test b/src/output/foundry-template/forge-test
diff --git a/src/output/fuzz_testing/forge-test-fail-fuzz b/src/output/fuzz_testing/forge-test-fail-fuzz
diff --git a/src/output/fuzz_testing/forge-test-no-fuzz b/src/output/fuzz_testing/forge-test-no-fuzz
diff --git a/src/output/fuzz_testing/forge-test-success-fuzz b/src/output/fuzz_testing/forge-test-success-fuzz
diff --git a/src/output/hello_foundry/forge-build b/src/output/hello_foundry/forge-build
diff --git a/src/output/hello_foundry/forge-init b/src/output/hello_foundry/forge-init
diff --git a/src/output/hello_foundry/forge-test b/src/output/hello_foundry/forge-test
diff --git a/src/output/nft_tutorial/forge-test b/src/output/nft_tutorial/forge-test
diff --git a/src/output/test_filters/forge-test-match-contract-and-test b/src/output/test_filters/forge-test-match-contract-and-test
diff --git a/src/output/test_filters/forge-test-match-path b/src/output/test_filters/forge-test-match-path
diff --git a/src/reference/cli/cast/call.md b/src/reference/cli/cast/call.md
@@ -47,6 +47,10 @@ Options:
   -h, --help
           Print help (see a summary with '-h')
 
+Display options:
+  -j, --json
+          Print the decoded output as JSON
+
 Transaction options:
       --gas-limit <GAS_LIMIT>
           Gas limit for the transaction

diff --git a/src/reference/cli/cast/interface.md b/src/reference/cli/cast/interface.md
@@ -4,17 +4,19 @@ Generate a Solidity interface from a given ABI.
 
 ```bash
 $ cast interface --help
-Usage: cast interface [OPTIONS] <PATH_OR_ADDRESS>
+Usage: cast interface [OPTIONS] <CONTRACT>
 
 Arguments:
-  <PATH_OR_ADDRESS>
-          The contract address, or the path to an ABI file.
-
-          If an address is specified, then the ABI is fetched from Etherscan.
+  <CONTRACT>
+          The target contract, which can be one of: - A file path to an ABI JSON file. - A contract
+          identifier in the form `<path>:<contractname>` or just `<contractname>`. - An Ethereum
+          address, for which the ABI will be fetched from Etherscan
 
 Options:
   -n, --name <NAME>
-          The name to use for the generated interface
+          The name to use for the generated interface.
+
+          Only relevant when retrieving the ABI from a file.
 
   -p, --pragma <VERSION>
           Solidity pragma version

diff --git a/src/reference/cli/forge/doc.md b/src/reference/cli/forge/doc.md
@@ -29,6 +29,36 @@ Options:
       --hostname <HOSTNAME>
           Hostname for serving documentation
 
+  -h, --help
+          Print help (see a summary with '-h')
+
+Watch options:
+  -w, --watch [<PATH>...]
+          Watch the given files or directories for changes.
+
+          If no paths are provided, the source and test directories of the project are watched.
+
+      --no-restart
+          Do not restart the command while it's still running
+
+      --run-all
+          Explicitly re-run all tests when a change is made.
+          
+          By default, only the tests of the last modified test file are executed.
+
+      --watch-delay <DELAY>
+          File update debounce delay.
+          
+          During the delay, incoming change events are accumulated and only once the delay has
+          passed, is an action taken. Note that this does not mean a command will be started: if
+          --no-restart is given and a command is already running, the outcome of the action will be
+          to do nothing.
+          
+          Defaults to 50ms. Parses as decimal seconds by default, but using an integer with the `ms`
+          suffix may be more convenient.
+          
+          When using --poll mode, you'll want a larger duration, or risk overloading disk I/O.
+
   -p, --port <PORT>
           Port for serving documentation
 
@@ -38,7 +68,4 @@ Options:
 
   -i, --include-libraries
           Whether to create docs for external libraries
-
-  -h, --help
-          Print help (see a summary with '-h')
 ```