Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Merged by Bors] - Updated README #2825

Closed
wants to merge 1 commit into from
Closed

[Merged by Bors] - Updated README #2825

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 13 additions & 37 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion boa_cli/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down