changed all references to ts-node consistent #1481
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cspotcode
reviewed
Oct 3, 2021
website/docs/configuration.md
Outdated
| ## Via tsconfig.json (recommended) | ||
|
|
||
| `ts-node` automatically finds and loads `tsconfig.json`. Most `ts-node` options can be specified in a `"ts-node"` object using their programmatic, camelCase names. We recommend this because it works even when you cannot pass CLI flags, such as `node --require ts-node/register` and when using shebangs. | ||
| ts-node automatically finds and loads `tsconfig.json`. Most ts-node options can be specified in a "ts-node" object using their programmatic, camelCase names. We recommend this because it works even when you cannot pass CLI flags, such as `node --require ts-node/register` and when using shebangs. |
There was a problem hiding this comment.
I think "ts-node" should still be in backticks since it's JSON syntax.
| | Transforms `import` into `require()` | Does not transform `import` | | ||
| | Node executes scripts using the classic [CommonJS loader](https://nodejs.org/dist/latest-v16.x/docs/api/modules.html) | Node executes scripts using the new [ESM loader](https://nodejs.org/dist/latest-v16.x/docs/api/esm.html) | | ||
| | Use any of:<br/>`ts-node` CLI<br/>`node -r ts-node/register`<br/>`NODE_OPTIONS="ts-node/register" node`<br/>`require('ts-node').register({/* options */})` | Must use the ESM loader via:<br/>`node --loader ts-node/esm`<br/>`NODE_OPTIONS="--loader ts-node/esm" node` | | ||
| | Use any of:<br/>ts-node CLI<br/>`node -r ts-node/register`<br/>`NODE_OPTIONS="ts-node/register" node`<br/>`require('ts-node').register({/* options */})` | Must use the ESM loader via:<br/>`node --loader ts-node/esm`<br/>`NODE_OPTIONS="--loader ts-node/esm" node` | |
There was a problem hiding this comment.
Should this be in backticks since it refers to the binary's name?
| `ts-node` uses sensible default configurations to reduce boilerplate while still respecting `tsconfig.json` if you | ||
| ts-node uses sensible default configurations to reduce boilerplate while still respecting `tsconfig.json` if you | ||
| have one. If you are unsure which configuration is used, you can log it with `ts-node --show-config`. This is similar to | ||
| `tsc --showConfig` but includes `"ts-node"` options as well. |
There was a problem hiding this comment.
Ditto previous comment about "ts-node" as JSON syntax.
website/docs/usage.md
Outdated
| You can require ts-node and register the loader for future requires by using `require('ts-node').register({ /* options */ })`. You can also use file shortcuts - `node -r ts-node/register` or `node -r ts-node/register/transpile-only` - depending on your preferences. | ||
|
|
||
| **Note:** If you need to use advanced node.js CLI arguments (e.g. `--inspect`), use them with `node -r ts-node/register` instead of the `ts-node` CLI. | ||
| **Note:** If you need to use advanced node.js CLI arguments (e.g. `--inspect`), use them with `node -r ts-node/register` instead of the ts-node CLI. |
There was a problem hiding this comment.
Ditto question about ts-node referring to the binary's name.
|
@animafps Thank you! |
cspotcode
added a commit
that referenced
this pull request
Oct 11, 2021
* upgrade typedoc (#1454) * update esm messaging in docs (#1455) * Update vscode debug config (#1466) * changed all references to ts-node consistent (#1481) * changed all references to ts-node consistent * Pesky maintainer-prerogative nitpicks Co-authored-by: Andrew Bradley <[email protected]> Co-authored-by: Anima <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
fixes consistency issues with ts-node references described in #1317
ts-node