oxc/tasks/transform_conformance/README.md
overlookmotel 7d32d2086c
test(transformer): update transform conformance README (#5919)
Add reference to our additional tests + tidy up capitalization.
2024-09-20 11:46:44 +01:00

48 lines
1.1 KiB
Markdown

# Transformation Conformance Test Runner
## Execution
This test runner uses the transformation plugin test suite from the Babel repository.
Additional tests are in the [tests](./tests/) directory.
The failing test cases are listed in:
- [babel.snap.md](./snapshots/babel.snap.md)
- [oxc.snap.md](./snapshots/oxc.snap.md)
To get started, run
```bash
cargo run -p oxc_transform_conformance
```
or watch for changes
```bash
just watch 'run -p oxc_transform_conformance'
```
## Options
### --filter
To filter for a specific test case, apply the `--filter path` option, e.g.
```bash
cargo run -p oxc_transform_conformance -- --filter react/arrow-functions
```
### --exec
The Babel test suite contains many `exec.js` files, which need to be executed by a runtime.
`bun` is the preferred way to execute these tests, which you may install them via [https://bun.sh/docs/installation](https://bun.sh/docs/installation).
Once `bun` is installed, apply the `--exec` flag:
```bash
cargo run -p oxc_transform_conformance -- --exec
```
The failing test cases are listed in [babel_exec.snap.md](./snapshots/babel_exec.snap.md).