From b1f4e0db6bc051d69cdff0a7aa94c982be6e470c Mon Sep 17 00:00:00 2001 From: Iban Eguia Moraza Date: Sat, 15 Apr 2023 18:11:24 +0000 Subject: [PATCH] Updated README (#2825) This Pull Request updates the README by including the latest output of the `--help` command line argument in boa_cli. --- README.md | 50 ++++++++++++--------------------------------- boa_cli/src/main.rs | 2 +- 2 files changed, 14 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index f731dd5d23..37c4f906c0 100644 --- a/README.md +++ b/README.md @@ -71,48 +71,24 @@ then go to `http://localhost:8080`. ## Command-line Options -```shell +``` Usage: boa [OPTIONS] [FILE]... Arguments: - [FILE]... - The JavaScript file(s) to be evaluated + [FILE]... The JavaScript file(s) to be evaluated Options: - --strict - Run in strict mode - - -a, --dump-ast [] - Dump the AST to stdout with the given format - - Possible values: - - debug: The different types of format available for dumping - - json - - json-pretty - - -t, --trace - Dump the AST to stdout with the given format - - --vi - Use vi mode in the REPL - - --flowgraph [] - Generate instruction flowgraph. Default is Graphviz - - Possible values: - - graphviz: Generates in graphviz format: - - mermaid: Generates in mermaid format: - - --flowgraph-direction - Specifies the direction of the flowgraph. Default is TopToBottom - - [possible values: top-to-bottom, bottom-to-top, left-to-right, right-to-left] - - -h, --help - Print help (see a summary with '-h') - - -V, --version - Print version + --strict Run in strict mode + -a, --dump-ast [] Dump the AST to stdout with the given format [possible values: debug, json, json-pretty] + -t, --trace Dump the AST to stdout with the given format + --vi Use vi mode in the REPL + -O, --optimize + --optimizer-statistics + --flowgraph [] Generate instruction flowgraph. Default is Graphviz [possible values: graphviz, mermaid] + --flowgraph-direction Specifies the direction of the flowgraph. Default is top-top-bottom [possible values: top-to-bottom, bottom-to-top, left-to-right, right-to-left] + --debug-object Inject debugging object `$boa` + -h, --help Print help (see more with '--help') + -V, --version Print version ``` ## Roadmap diff --git a/boa_cli/src/main.rs b/boa_cli/src/main.rs index 39089eb0ac..427aa42431 100644 --- a/boa_cli/src/main.rs +++ b/boa_cli/src/main.rs @@ -139,7 +139,7 @@ struct Opt { #[allow(clippy::option_option)] flowgraph: Option>, - /// Specifies the direction of the flowgraph. Default is TopToBottom. + /// Specifies the direction of the flowgraph. Default is top-top-bottom. #[arg( long, value_name = "FORMAT",