Skip to content

Commit ccf8c8e

Browse files
Docs merge for 10.3.2 (#1530)
* Fix inconsistent reference to ts-node in docs * docs: regenerator-runtime dependency for swc (#1508) (#1509) * docs: regenerator-runtime dependency for swc (#1508) * docs(transpilers): update advice for installing regenerator-runtime * Update transpilers.md Co-authored-by: Andrew Bradley <[email protected]> Co-authored-by: Peter Coulton <[email protected]>
1 parent 889c21d commit ccf8c8e

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

website/docs/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ npm install -g ts-node
1515
npm install -D tslib @types/node
1616
```
1717

18-
**Tip:** Installing modules locally allows you to control and share the versions through `package.json`. TS Node will always resolve the compiler from `cwd` before checking relative to its own installation.
18+
**Tip:** Installing modules locally allows you to control and share the versions through `package.json`. ts-node will always resolve the compiler from `cwd` before checking relative to its own installation.

website/docs/transpilers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ We have bundled an experimental `swc` integration.
2020
[`swc`](https://swc.rs) is a TypeScript-compatible transpiler implemented in Rust. This makes it an order of magnitude faster
2121
than `transpileModule`.
2222

23-
To use it, first install `@swc/core` or `@swc/wasm`. If using `importHelpers`, also install `@swc/helpers`.
23+
To use it, first install `@swc/core` or `@swc/wasm`. If using `importHelpers`, also install `@swc/helpers`. If `target` is less than "es2015" and using either `async`/`await` or generator functions, also install `regenerator-runtime`.
2424

2525
```shell
26-
npm i -D @swc/core @swc/helpers
26+
npm i -D @swc/core @swc/helpers regenerator-runtime
2727
```
2828

2929
Then add the following to your `tsconfig.json`.

0 commit comments

Comments
 (0)