Fix broken forc command docs (#6424)

JoshuaBatty · web-flow · commit 7dc3e2d74571 · 2024-08-19T15:49:28.000+02:00
## Description I noticed that the command section for forc in the documentation was only showing headings and no information about the commands themselves. See below. ![Screenshot 2024-08-19 at 10 47 48 AM](https://github.com/user-attachments/assets/ee5c00d3-97f2-445a-b1c7-203144bf2d13) This was due to back ticks being placed around the heading in #5369. I've removed these ticks and added the commands to the list of accepted words. Also there were a lot of commands being missed due to their no longer being subcommands, this logic has been updated and all the forc commands are now being parsed. ## Checklist - [x] I have linked to any relevant issues. - [x] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [x] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [x] I have added tests that prove my fix is effective or that my feature works. - [x] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - [x] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers.
diff --git a/docs/book/spell-check-custom-words.txt b/docs/book/spell-check-custom-words.txt
@@ -4,6 +4,7 @@ ASM
 IDE
 IDEs
 LSP
+lsp
 namespace
 ALU
 APIs
@@ -216,4 +217,14 @@ underflows
 Codec
 bool
 str
-multisig
+multisig
+addr
+addr2line
+contract-id
+init
+parse-bytecode
+predicate-root
+forc-client
+crypto
+doc
+fmt
diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
@@ -80,28 +80,28 @@
   - [Workspaces](./forc/workspaces.md)
   - [Dependencies](./forc/dependencies.md)
   - [Commands](./forc/commands/index.md)
-    - [`forc addr2line`](./forc/commands/forc_addr2line.md)
-    - [`forc build`](./forc/commands/forc_build.md)
-    - [`forc check`](./forc/commands/forc_check.md)
-    - [`forc clean`](./forc/commands/forc_clean.md)
-    - [`forc completions`](./forc/commands/forc_completions.md)
-    - [`forc contract-id`](./forc/commands/forc_contract-id.md)
-    - [`forc init`](./forc/commands/forc_init.md)
-    - [`forc new`](./forc/commands/forc_new.md)
-    - [`forc parse-bytecode`](./forc/commands/forc_parse-bytecode.md)
-    - [`forc plugins`](./forc/commands/forc_plugins.md)
-    - [`forc predicate-root`](./forc/commands/forc_predicate-root.md)
-    - [`forc test`](./forc/commands/forc_test.md)
-    - [`forc update`](./forc/commands/forc_update.md)
-    - [`forc template`](./forc/commands/forc_template.md)
+    - [forc addr2line](./forc/commands/forc_addr2line.md)
+    - [forc build](./forc/commands/forc_build.md)
+    - [forc check](./forc/commands/forc_check.md)
+    - [forc clean](./forc/commands/forc_clean.md)
+    - [forc completions](./forc/commands/forc_completions.md)
+    - [forc contract-id](./forc/commands/forc_contract-id.md)
+    - [forc init](./forc/commands/forc_init.md)
+    - [forc new](./forc/commands/forc_new.md)
+    - [forc parse-bytecode](./forc/commands/forc_parse-bytecode.md)
+    - [forc plugins](./forc/commands/forc_plugins.md)
+    - [forc predicate-root](./forc/commands/forc_predicate-root.md)
+    - [forc test](./forc/commands/forc_test.md)
+    - [forc update](./forc/commands/forc_update.md)
+    - [forc template](./forc/commands/forc_template.md)
   - [Plugins](./forc/plugins/index.md)
-    - [`forc client`](./forc/plugins/forc_client/index.md)
-      - [`forc deploy`](./forc/plugins/forc_client/forc_deploy.md)
-      - [`forc run`](./forc/plugins/forc_client/forc_run.md)
-      - [`forc submit`](./forc/plugins/forc_client/forc_submit.md)
-    - [`forc crypto`](./forc/plugins/forc_crypto.md)
-    - [`forc debug`](./forc/plugins/forc_debug.md)
-    - [`forc doc`](./forc/plugins/forc_doc.md)
-    - [`forc explore`](./forc/plugins/forc_explore.md)
-    - [`forc fmt`](./forc/plugins/forc_fmt.md)
-    - [`forc lsp`](./forc/plugins/forc_lsp.md)
+    - [forc client](./forc/plugins/forc_client/index.md)
+      - [forc deploy](./forc/plugins/forc_client/forc_deploy.md)
+      - [forc run](./forc/plugins/forc_client/forc_run.md)
+      - [forc submit](./forc/plugins/forc_client/forc_submit.md)
+    - [forc crypto](./forc/plugins/forc_crypto.md)
+    - [forc debug](./forc/plugins/forc_debug.md)
+    - [forc doc](./forc/plugins/forc_doc.md)
+    - [forc explore](./forc/plugins/forc_explore.md)
+    - [forc fmt](./forc/plugins/forc_fmt.md)
+    - [forc lsp](./forc/plugins/forc_lsp.md)
diff --git a/docs/book/src/forc/commands/forc_addr2line.md b/docs/book/src/forc/commands/forc_addr2line.md
@@ -1 +1 @@
-# `forc addr2line`
+# forc addr2line
diff --git a/docs/book/src/forc/commands/forc_build.md b/docs/book/src/forc/commands/forc_build.md
@@ -1 +1 @@
-# `forc build`
+# forc build
diff --git a/docs/book/src/forc/commands/forc_check.md b/docs/book/src/forc/commands/forc_check.md
@@ -1 +1 @@
-# `forc check`
+# forc check
diff --git a/docs/book/src/forc/commands/forc_clean.md b/docs/book/src/forc/commands/forc_clean.md
@@ -1 +1 @@
-# `forc clean`
+# forc clean
diff --git a/docs/book/src/forc/commands/forc_completions.md b/docs/book/src/forc/commands/forc_completions.md
@@ -1 +1 @@
-# `forc completions`
+# forc completions
diff --git a/docs/book/src/forc/commands/forc_contract-id.md b/docs/book/src/forc/commands/forc_contract-id.md
@@ -1 +1 @@
-# `forc contract-id`
+# forc contract-id
diff --git a/docs/book/src/forc/commands/forc_init.md b/docs/book/src/forc/commands/forc_init.md
@@ -1 +1 @@
-# `forc init`
+# forc init
diff --git a/docs/book/src/forc/commands/forc_new.md b/docs/book/src/forc/commands/forc_new.md
@@ -1 +1 @@
-# `forc new`
+# forc new
diff --git a/docs/book/src/forc/commands/forc_parse-bytecode.md b/docs/book/src/forc/commands/forc_parse-bytecode.md
@@ -1 +1 @@
-# `forc parse-bytecode`
+# forc parse-bytecode
diff --git a/docs/book/src/forc/commands/forc_plugins.md b/docs/book/src/forc/commands/forc_plugins.md
@@ -1 +1 @@
-# `forc plugins`
+# forc plugins
diff --git a/docs/book/src/forc/commands/forc_predicate-root.md b/docs/book/src/forc/commands/forc_predicate-root.md
@@ -1 +1 @@
-# `forc predicate-root`
+# forc predicate-root
diff --git a/docs/book/src/forc/commands/forc_template.md b/docs/book/src/forc/commands/forc_template.md
@@ -1 +1 @@
-# `forc template`
+# forc template
diff --git a/docs/book/src/forc/commands/forc_test.md b/docs/book/src/forc/commands/forc_test.md
@@ -1 +1 @@
-# `forc test`
+# forc test
diff --git a/docs/book/src/forc/commands/forc_update.md b/docs/book/src/forc/commands/forc_update.md
@@ -1 +1 @@
-# `forc update`
+# forc update
diff --git a/docs/book/src/forc/plugins/forc_client/forc_deploy.md b/docs/book/src/forc/plugins/forc_client/forc_deploy.md
@@ -1 +1 @@
-# `forc deploy`
+# forc deploy
diff --git a/docs/book/src/forc/plugins/forc_client/forc_run.md b/docs/book/src/forc/plugins/forc_client/forc_run.md
@@ -1 +1 @@
-# `forc run`
+# forc run
diff --git a/docs/book/src/forc/plugins/forc_client/forc_submit.md b/docs/book/src/forc/plugins/forc_client/forc_submit.md
@@ -1 +1 @@
-# `forc submit`
+# forc submit
diff --git a/docs/book/src/forc/plugins/forc_client/index.md b/docs/book/src/forc/plugins/forc_client/index.md
@@ -1,4 +1,4 @@
-# `forc-client`
+# forc-client
 
 The forc plugin for interacting with a Fuel node.
 
diff --git a/docs/book/src/forc/plugins/forc_crypto.md b/docs/book/src/forc/plugins/forc_crypto.md
@@ -1 +1 @@
-# `forc crypto`
+# forc crypto
diff --git a/docs/book/src/forc/plugins/forc_doc.md b/docs/book/src/forc/plugins/forc_doc.md
@@ -1 +1 @@
-# `forc doc`
+# forc doc
diff --git a/docs/book/src/forc/plugins/forc_explore.md b/docs/book/src/forc/plugins/forc_explore.md
@@ -1 +1 @@
-# `forc explore`
+# forc explore
diff --git a/docs/book/src/forc/plugins/forc_fmt.md b/docs/book/src/forc/plugins/forc_fmt.md
@@ -1 +1 @@
-# `forc fmt`
+# forc fmt
diff --git a/docs/book/src/forc/plugins/forc_lsp.md b/docs/book/src/forc/plugins/forc_lsp.md
@@ -1 +1 @@
-# `forc lsp`
+# forc lsp
diff --git a/scripts/mdbook-forc-documenter/src/bin/mdbook-forc-documenter.rs b/scripts/mdbook-forc-documenter/src/bin/mdbook-forc-documenter.rs
@@ -1,18 +1,21 @@
 use clap::{Arg, ArgMatches, Command};
 use mdbook::errors::Error;
 use mdbook::preprocess::{CmdPreprocessor, Preprocessor};
+use mdbook_forc_documenter::ForcDocumenter;
 use semver::{Version, VersionReq};
 use std::io;
 use std::process;
 
-use mdbook_forc_documenter::ForcDocumenter;
-
 pub fn make_app() -> Command {
     Command::new("forc-documenter")
         .about("A mdbook preprocessor which documents Forc commands")
         .subcommand(
             Command::new("supports")
-                .arg(Arg::new("renderer").required(true))
+                .arg(
+                    Arg::new("renderer")
+                        .required(true)
+                        .value_parser(clap::value_parser!(String)),
+                )
                 .about("Check whether a renderer is supported by this preprocessor"),
         )
 }
@@ -53,7 +56,7 @@ fn handle_preprocessing(pre: &dyn Preprocessor) -> Result<(), Error> {
 }
 
 fn handle_supports(pre: &dyn Preprocessor, sub_args: &ArgMatches) -> ! {
-    let renderer: &Option<&str> = sub_args.get_one("renderer").expect("Required argument");
+    let renderer = sub_args.get_one::<String>("renderer").map(String::as_str);
     let supported = renderer.map(|r| pre.supports_renderer(r)).unwrap_or(false);
 
     // Signal whether the renderer is supported by exiting with 1 or 0.
diff --git a/scripts/mdbook-forc-documenter/src/commands.rs b/scripts/mdbook-forc-documenter/src/commands.rs
@@ -1,11 +1,8 @@
 use crate::formatter::{format_header_line, format_line};
 use anyhow::{anyhow, Result};
-use std::collections::HashMap;
-use std::ffi::OsString;
-use std::process;
+use std::{collections::HashMap, ffi::OsString, process};
 
 pub fn possible_forc_commands() -> Vec<String> {
-    let mut possible_commands = Vec::new();
     let output = process::Command::new("forc")
         .arg("--help")
         .output()
@@ -14,18 +11,27 @@ pub fn possible_forc_commands() -> Vec<String> {
     let output_str = String::from_utf8_lossy(&output.stdout);
     let lines = output_str.lines();
 
-    let mut has_parsed_subcommand_header = false;
+    let mut possible_commands = Vec::new();
+    let mut in_commands_section = false;
 
     for line in lines {
-        if has_parsed_subcommand_header {
-            let (command, _) = line.trim().split_once(' ').unwrap_or(("", ""));
-            possible_commands.push(command.to_string());
+        if line.trim() == "Commands:" {
+            // Start of commands section
+            in_commands_section = true;
+            continue;
         }
-        if line == "SUBCOMMANDS:" {
-            has_parsed_subcommand_header = true;
+
+        if in_commands_section {
+            if line.trim().is_empty() || line.trim().starts_with("Options:") {
+                // End of commands section
+                break;
+            }
+            // Extract command name (first word of the line)
+            if let Some(command) = line.split_whitespace().next() {
+                possible_commands.push(command.to_string());
+            }
         }
     }
-
     possible_commands
 }
 

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-# `forc completions`
	`1`	`+# forc completions`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-# `forc contract-id`
	`1`	`+# forc contract-id`