chore(output): weekly command output update (#1336)

update command output Co-authored-by: mattsse <[email protected]>
foundry-rs · Oct 20, 2024 · 4317603 · 4317603
1 parent c1fe66d
commit 4317603
Show file tree

Hide file tree

Showing 21 changed files with 98 additions and 38 deletions.
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -92,6 +92,8 @@
         - [`forge cache ls`](./reference/cli/forge/cache/ls.md)
       - [`forge clean`](./reference/cli/forge/clean.md)
       - [`forge clone`](./reference/cli/forge/clone.md)
+      - [`forge compiler`](./reference/cli/forge/compiler.md)
+        - [`forge compiler resolve`](./reference/cli/forge/compiler/resolve.md)
       - [`forge completions`](./reference/cli/forge/completions.md)
       - [`forge config`](./reference/cli/forge/config.md)
       - [`forge coverage`](./reference/cli/forge/coverage.md)

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-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/SUMMARY.md b/src/reference/cli/SUMMARY.md
@@ -7,6 +7,8 @@
     - [`forge cache ls`](./forge/cache/ls.md)
   - [`forge clean`](./forge/clean.md)
   - [`forge clone`](./forge/clone.md)
+  - [`forge compiler`](./forge/compiler.md)
+    - [`forge compiler resolve`](./forge/compiler/resolve.md)
   - [`forge completions`](./forge/completions.md)
   - [`forge config`](./forge/config.md)
   - [`forge coverage`](./forge/coverage.md)

diff --git a/src/reference/cli/forge.md b/src/reference/cli/forge.md
@@ -18,6 +18,7 @@ Commands:
   clean              Remove the build artifacts and cache directories [aliases:
                      cl]
   clone              Clone a contract from Etherscan
+  compiler           Compiler utilities
   completions        Generate shell completions script [aliases: com]
   config             Display the current config [aliases: co]
   coverage           Generate coverage reports

diff --git a/src/reference/cli/forge/compiler.md b/src/reference/cli/forge/compiler.md
@@ -0,0 +1,19 @@
+# forge compiler
+
+Compiler utilities
+
+```bash
+$ forge compiler --help
+```
+
+```txt
+Usage: forge compiler <COMMAND>
+
+Commands:
+  resolve  Retrieves the resolved version(s) of the compiler within the project
+           [aliases: r]
+  help     Print this message or the help of the given subcommand(s)
+
+Options:
+  -h, --help  Print help
+```
diff --git a/src/reference/cli/forge/compiler/resolve.md b/src/reference/cli/forge/compiler/resolve.md
@@ -0,0 +1,36 @@
+# forge compiler resolve
+
+Retrieves the resolved version(s) of the compiler within the project
+
+```bash
+$ forge compiler resolve --help
+```
+
+```txt
+Usage: forge compiler resolve [OPTIONS]
+
+Options:
+  -r, --root <PATH>
+          The root directory
+
+  -s, --skip <REGEX>
+          Skip files that match the given regex pattern
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+Display options:
+  -v, --verbosity...
+          Verbosity of the output.
+          
+          Pass multiple times to increase the verbosity (e.g. -v, -vv, -vvv).
+          
+          Verbosity levels:
+          - 0: Print compiler versions.
+          - 1: Print compiler version and source paths.
+          - 2: Print compiler version, source paths and max supported EVM
+          version of the compiler.
+
+  -j, --json
+          Print as JSON
+```