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]>
TypeStrong · Oct 22, 2021 · ccf8c8e · ccf8c8e
1 parent 889c21d
commit ccf8c8e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/website/docs/installation.md b/website/docs/installation.md
@@ -15,4 +15,4 @@ npm install -g ts-node
 npm install -D tslib @types/node
 ```
 
-**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.
+**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.
diff --git a/website/docs/transpilers.md b/website/docs/transpilers.md
@@ -20,10 +20,10 @@ We have bundled an experimental `swc` integration.
 [`swc`](https://swc.rs) is a TypeScript-compatible transpiler implemented in Rust.  This makes it an order of magnitude faster
 than `transpileModule`.
 
-To use it, first install `@swc/core` or `@swc/wasm`.  If using `importHelpers`, also install `@swc/helpers`.
+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`.
 
 ```shell
-npm i -D @swc/core @swc/helpers
+npm i -D @swc/core @swc/helpers regenerator-runtime
 ```
 
 Then add the following to your `tsconfig.json`.