doc: update typescript docs #7412
Merged
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
Fix a small conceptual issue and add details for v23 Signed-off-by: Lucas Santos <lhs.santoss@gmail.com>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
cc @nodejs/typescript |
araujogui
approved these changes
Jan 20, 2025
jakebailey
reviewed
Jan 20, 2025
jakebailey
reviewed
Jan 20, 2025
jakebailey
reviewed
Jan 20, 2025
There was a problem hiding this comment.
General note :
- use pin node version in the doc like https://nodejs.org/docs/latest-v23.x/api/typescript.html
- add link to doc for --experimental-transform-types
himself65
approved these changes
Jan 20, 2025
robpalme
reviewed
Jan 20, 2025
Co-authored-by: Augustin Mauroy <augustin.mauroy@outlook.fr> Signed-off-by: Lucas Santos <lhs.santoss@gmail.com>
Co-authored-by: Rob Palmer <rob.palmer2@gmail.com> Signed-off-by: Lucas Santos <lhs.santoss@gmail.com>
Done! Also added a link to V23's |
jakebailey
approved these changes
Jan 20, 2025
|
It seems to be stuck apparently, I can't get any results from the checks back and it's blocking the merge 🤔 |
github-actions
bot
removed
the
github_actions:pull-request
|
Lighthouse Results
|
Unit Test Coverage Report
Unit Test Report
|
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.
Description
This PR extends and improves upon the original article about "How to run TS with Node". It fixes a small conceptual issue (using both flags), while adding the configuration section to point that the users will probably need to update their tsconfig and expands on new versions of node, especially on v23 which enables type stripping by default, but not type transformation.
Overall, it just adds more information on running TS by default.
Validation
Documentation change, no code.
Check List
npm run formatto ensure the code follows the style guide.npm run testto check if all tests are passing.npx turbo buildto check if the website builds without errors.