doc: recommend setting noEmit: true in tsconfig.json
#57320
Merged
+5
−0
Conversation
This file contains 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
|
Review requested:
|
jakebailey
reviewed
Mar 4, 2025
marco-ippolito
approved these changes
Mar 5, 2025
robpalme
reviewed
Mar 5, 2025
doc/api/typescript.md
Outdated
| @@ -81,6 +81,7 @@ but we recommend version 5.8 or newer with the following `tsconfig.json` setting | |||
| ```json | |||
| { | |||
| "compilerOptions": { | |||
| "noEmit": true, // Optional - prevent tsc from emitting transpiled JS | |||
There was a problem hiding this comment.
The current wording is a literal description of the tsconfig flag - which can be independently googled. I think the added value we can bring here in the docs is to explain why you might want to use it. For example...
Suggested change
| "noEmit": true, // Optional - prevent tsc from emitting transpiled JS | |
| "noEmit": true, // Optional - see Note (1) | |
| ... | |
| Note (1): `"noEmit"` is useful if your code is only intended to be consumed and executed as `*.ts` files. If instead you need to produce `*.js` files for performance or distribution reasons, you won't need this flag. |
There was a problem hiding this comment.
Added a variation of this in 839322d
MoLow
approved these changes
Mar 5, 2025
| @@ -90,6 +91,10 @@ but we recommend version 5.8 or newer with the following `tsconfig.json` setting | |||
| } | |||
| ``` | |||
|
|
|||
| > \[!NOTE] | |||
| > Use the `noEmit` option if you intend to only execute `*.ts` files, for example a build script. | |||
| > You won't need this flag if you intend to distribute `*.js` files for performance reasons. | |||
There was a problem hiding this comment.
Suggested change
| > You won't need this flag if you intend to distribute `*.js` files for performance reasons. | |
| > You won't need this flag if you intend to distribute `*.js` files. |
for whatever reason like npm package
There was a problem hiding this comment.
Sounds good to me. I created a new PR since this one already merged.
robpalme
approved these changes
Mar 6, 2025
marco-ippolito
approved these changes
Mar 6, 2025
marco-ippolito
added
author ready
nodejs-github-bot
removed
the
commit-queue
|
Landed in 5401ac6 |
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.
noEmit: truefrom defaulttsconfig.jsonin type stripping docs #57294