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

chore: update __runtime_js_source -> hmr #554

Merged
merged 1 commit into from
Jul 8, 2024
Merged

chore: update __runtime_js_source -> hmr #554

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
16 changes: 8 additions & 8 deletions runtime/manual/references/contributing/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,23 @@ Some systems, including a large part of the Node.js compatibility layer are
implemented in JavaScript and TypeScript modules. These are a good place to
start if you are looking to make your first contribution.

While iterating on such modules it is recommended to include
`--features __runtime_js_sources` in your `cargo` flags. This is a special
development mode where the JS/TS sources are not included in the binary but read
at runtime, meaning the binary will not have to be rebuilt if they are changed.
While iterating on such modules it is recommended to include `--features hmr` in
your `cargo` flags. This is a special development mode where the JS/TS sources
are not included in the binary but read at runtime, meaning the binary will not
have to be rebuilt if they are changed.

> To use the commands below, you need to first install the necessary tools on
> your system as described [here](building_from_source).

```sh
# cargo build
cargo build --features __runtime_js_sources
cargo build --features hmr

# cargo run -- run hello.ts
cargo run --features __runtime_js_sources -- run hello.ts
cargo run --features hmr -- run hello.ts

# cargo test integration::node_unit_tests::os_test
cargo test --features __runtime_js_sources integration::node_unit_tests::os_test
cargo test --features hmr integration::node_unit_tests::os_test
```

Also remember to reference this feature flag in your editor settings. For VSCode
Expand All @@ -56,7 +56,7 @@ users, combine the following into your workspace file:
```json
{
"settings": {
"rust-analyzer.cargo.features": ["__runtime_js_sources"]
"rust-analyzer.cargo.features": ["hmr"]
}
}
```
Expand Down