4.5 KiB
Contributing to Boa
Boa welcomes contribution from everyone. Here are the guidelines if you are thinking of helping out:
Contributions
Contributions to Boa or its dependencies should be made in the form of GitHub pull requests. Each pull request will be reviewed by a core contributor (someone with permission to land patches) and either landed in the main tree or given feedback for changes that would be required. All contributions should follow this format.
Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue.
Head over to issues and check for "good first issue" labels to find good tasks to start with. If you come across words or jargon that do not make sense, please ask!
If you don't already have Rust installed rustup is the recommended tool to use. It will install Rust and allow you to switch between nightly, stable and beta. You can also install additional components. In Linux, you can run:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Then simply clone this project and cargo build.
Running the compiler
You can execute a Boa console by running cargo run, and you can compile a list
of JavaScript files by running cargo run -- file1.js file2.js and so on.
Debugging
Knowing how to debug the interpreter should help you resolve problems quite quickly. See Debugging.
Web Assembly
If you want to develop on the web assembly side you can run yarn serve and then go
to http://localhost:8080.
Setup
VSCode Plugins
Either the Rust (RLS) or the Rust Analyzer extensions are preferred. RLS is easier to set up but some of the development is moving towards Rust Analyzer. Both of these plugins will help you with your Rust Development
Tasks
There are some pre-defined tasks in tasks.json
- Build - shift+cmd/ctrl+b should build and run cargo. You should be able to make changes and run this task.
- Test - (there is no shortcut, you'll need to make one) - Runs
Cargo Test. I personally set a shortcut of shift+cmd+option+T (or shift+ctrl+alt+T)
Testing
Boa provides its own test suite, and can also run the official ECMAScript test suite. To run the Boa test
suite, you can just run the normal cargo test, and to run the full ECMAScript test suite, you can run it
with this command:
cargo run --release --bin boa_tester -- run -v 2> error.log
This will run the test suite in verbose mode (you can remove the -v part to run it in non-verbose mode),
and output nice colorings in the terminal. It will also output any panic information into the error.log file.
You can get some more verbose information that tells you the exact name of each test that is being run, useful
for debugging purposes by setting up the verbose flag twice, for example -vv. If you want to know the output of
each test that is executed, you can use the triple verbose (-vvv) flag.
If you want to only run one sub-suite or even one test (to just check if you fixed/broke something specific),
you can do it with the -s parameter, and then passing the path to the sub-suite or test that you want to run. Note
that the -s parameter value should be a path relative to the test262 directory. For example, to run the number
type tests, use -s test/language/types/number.
Finally, if you're using the verbose flag and running a sub suite with a small number of tests, then the output will
be more readable if you disable parallelism with the -d flag. All together it might look something like:
cargo run --release --bin boa_tester -- run -vv -d -s test/language/types/number 2> error.log
Documentation
To build the development documentation, run:
cargo doc --all-features --document-private-items --workspace
This will also document all the dependencies on the workspace, which could be heavier in size.
To only generate documentation for the workspace members, just add the --no-deps flag:
cargo doc --all-features --document-private-items --workspace --no-deps
Communication
We have a Matrix space, feel free to ask questions here: https://matrix.to/#/#boa:matrix.org