boa/README.md

Boa

This is an experimental Javascript lexer, parser and interpreter written in Rust. Currently, it has support for some of the language.

Live Demo (WASM)

https://boa-dev.github.io/boa/

You can get more verbose errors when running from the command line.

Development documentation

You can check the internal development docs at https://boa-dev.github.io/boa/doc.

Conformance

To know how much of the ECMAScript specification does Boa cover, you can check out results running the ECMASCript Test262 test suite here.

Benchmarks

See Benchmarks.

Contributing

Please, check the CONTRIBUTING.md file to know how to contribute in the project. You will need Rust installed and an editor. We have some configurations ready for VSCode.

Debugging

Check debugging.md for more info on debugging.

Web Assembly

This interpreter can be exposed to javascript! You can build the example locally with:

$ yarn install
$ yarn serve

In the console you can use window.evaluate to pass JavaScript in. To develop on the web assembly side you can run yarn serve then go to http://localhost:8080.

Roadmap

See Milestones.

Changelog

See CHANGELOG.md.

Usage

• Clone this repo.
• Run with cargo run -- test.js where test.js is an existing JS file.
• If any JS doesn't work then it's a bug. Please raise an issue!

Profiling

See Profiling

Command-line Options

USAGE:
    boa_cli [OPTIONS] [FILE]...

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -a, --dump-ast <FORMAT>       Dump the abstract syntax tree (ast) to stdout with the given format [possible values: Debug, Json,
                                  JsonPretty]

ARGS:
    <FILE>...    The JavaScript file(s) to be evaluated

Communication

Feel free to contact us on Discord.

Example

License

This project is licensed under the Unlicense or MIT licenses, at your option.