Browse Source

Updated README (#2825)

This Pull Request updates the README by including the latest output of the `--help` command line argument in boa_cli.
pull/2829/head
Iban Eguia Moraza 2 years ago
parent
commit
b1f4e0db6b
  1. 50
      README.md
  2. 2
      boa_cli/src/main.rs

50
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 [<FORMAT>]
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 [<FORMAT>]
Generate instruction flowgraph. Default is Graphviz
Possible values:
- graphviz: Generates in graphviz format: <https://graphviz.org/>
- mermaid: Generates in mermaid format: <https://mermaid-js.github.io/mermaid/>
--flowgraph-direction <FORMAT>
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 [<FORMAT>] 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 [<FORMAT>] Generate instruction flowgraph. Default is Graphviz [possible values: graphviz, mermaid]
--flowgraph-direction <FORMAT> 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

2
boa_cli/src/main.rs

@ -139,7 +139,7 @@ struct Opt {
#[allow(clippy::option_option)]
flowgraph: Option<Option<FlowgraphFormat>>,
/// 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",

Loading…
Cancel
Save