`) since they look like HTML tags
+ let text = text.replace("<", "<").replace(">", ">");
+
+ // Italicize the first line (command name and version text)
let re = Regex::new("^(.*?)\n").expect("Regex compilation should not fail");
- let text = re.replace_all(&text, "*$1*\n\n");
+ let text = re.replace_all(&text, "$1\n");
- // Wrap command names in backticks
+ // Unmerge wrapped lines
+ let text = text.replace("\n ", " ");
+
+ // Wrap option names in backticks. The lines look like:
+ // -V, --version Prints version information
+ // And are converted to:
+ // -V, --version: Prints version information
// (?m) enables multi-line mode for ^ and $
- let re = Regex::new("(?m)^ ([a-z-]+) +(.*)$").expect("Regex compilation should not fail");
- let text = re.replace_all(&text, " `$1`: $2");
+ let re = Regex::new("(?m)^ (([a-zA-Z_&;-]+(, )?)+) +(.*)$")
+ .expect("Regex compilation should not fail");
+ let text = re.replace_all(&text, "$1: $4");
- // Add * to list items
- let re = Regex::new("(?m)^ (.*)$").expect("Regex compilation should not fail");
- let text = re.replace_all(&text, "* $1");
+ // // Enclose examples in code blocks
+ // // (?ms) enables multi-line mode and dot-matches-all
+ // let re =
+ // Regex::new("(?ms)^Example:\n(.*?)\nUSAGE:$").expect("Regex compilation should not fail");
+ // let text = re.replace_all(&text, "EXAMPLE:\n$1
\nUSAGE:");
- // Turn section names to headings
- let re = Regex::new("(?m)^([A-Z-]+):$").expect("Regex compilation should not fail");
- let text = re.replace_all(&text, "#### $1");
+ let has_yaml_block_marker = text.contains("\n[add-yaml-block-to-usage]\n");
+ let text = text.replace("\n[add-yaml-block-to-usage]\n", "");
+
+ // Add HTML line-breaks
+ let text = text.replace("\n", "
\n");
+
+ let text = if !has_yaml_block_marker {
+ // Wrap the usage line in code tags
+ let re = Regex::new("(?m)^USAGE:
\n (@conduit:.*)
$")
+ .expect("Regex compilation should not fail");
+ re.replace_all(&text, "USAGE:
\n$1
")
+ } else {
+ // Wrap the usage line in a code block, and add a yaml block example
+ // This makes the usage of e.g. `register-appservice` more accurate
+ let re = Regex::new("(?m)^USAGE:
\n (.*?)
\n
\n")
+ .expect("Regex compilation should not fail");
+ re.replace_all(
+ &text,
+ "USAGE:
\n$1\n```\nyaml content here\n```
",
+ )
+ };
text.to_string()
}
-
-// Convert markdown to HTML using the CommonMark flavor
-fn markdown_to_html(text: &str) -> String {
- // CommonMark's spec allows HTML tags; however, CLI required arguments look
- // very much like tags so escape them.
- let text = text.replace("<", "<").replace(">", ">");
-
- let mut html_output = String::new();
-
- let parser = pulldown_cmark::Parser::new(&text);
- pulldown_cmark::html::push_html(&mut html_output, parser);
-
- html_output
-}