Add examples for forc-test

forc-plugins/forc-doc/Cargo.toml

@@ -13,7 +13,6 @@ anyhow = "1.0.65"
 clap = { version = "4.0.18", features = ["derive"] }
 colored = "2.0.0"
 comrak = "0.16"
-forc = { version = "0.48.1", path = "../../forc" }
 forc-pkg = { version = "0.48.1", path = "../../forc-pkg" }
 forc-util = { version = "0.48.1", path = "../../forc-util" }
 horrorshow = "0.8.4"

forc-util/src/cli.rs

@@ -14,7 +14,11 @@ macro_rules! cli_examples {
                     let mut proc = std::process::Command::new("cargo");
                     proc.arg("run");
                     proc.arg("--bin");
-                    proc.arg(format!("forc-{}", stringify!($command)));
+                    proc.arg(if stringify!($command) == "forc" {
+                        "forc".to_owned()
+                    } else {
+                        format!("forc-{}", stringify!($command))
+                    });
                     proc.arg("--");
 
                     super::parse_args($args).into_iter().for_each(|arg| {
@@ -127,7 +131,11 @@ macro_rules! cli_examples {
             Box::leak( [
             $(
             $crate::paste::paste! {
+                if stringify!($command) == "forc" {
+                    format!("  #{}\n  forc {}\n\n", stringify!($($description)*), $args )
+                } else {
                     format!("  #{}\n  forc {} {}\n\n", stringify!($($description)*), stringify!($command), $args )
+                }
             },
             )*
             ].concat().into_boxed_str())

forc/src/cli/commands/test.rs

@@ -6,6 +6,12 @@ use forc_test::{TestFilter, TestRunnerCount, TestedPackage};
 use forc_util::{tx_utils::format_log_receipts, ForcError, ForcResult};
 use tracing::info;
 
+forc_util::cli_examples! {
+    [ Run test => forc "test" => ".*could not find `Forc.toml`.*" ]
+    [ Run test without any output => forc "test --silent" => "^$" ]
+    [ Run test without creating or update the lock file  => forc "test --locked" => ".*could not find `Forc.toml`.*" ]
+}
+
 /// Run the Sway unit tests for the current project.
 ///
 /// NOTE: Previously this command was used to support Rust integration testing, however the
@@ -42,6 +48,7 @@ pub struct Command {
 
 /// The set of options provided for controlling output of a test.
 #[derive(Parser, Debug, Clone)]
+#[clap(after_help = help())]
 pub struct TestPrintOpts {
     #[clap(long = "pretty-print", short = 'r')]
     /// Pretty-print the logs emiited from tests.