Skip to content

doc: update typescript docs - #7412

Merged
khaosdoctor merged 7 commits into
mainfrom
doc-ts-with-node
Jan 21, 2025
Merged

doc: update typescript docs#7412
khaosdoctor merged 7 commits into
mainfrom
doc-ts-with-node

Conversation

@khaosdoctor

@khaosdoctorkhaosdoctor commented Jan 20, 2025

Copy link
Copy Markdown
Member

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

  • I have read the Contributing Guidelines and made commit messages that follow the guideline.
  • I have run npm run format to ensure the code follows the style guide.
  • I have run npm run test to check if all tests are passing.
  • I have run npx turbo build to check if the website builds without errors.
  • I've covered new added functionality with unit tests if necessary.

Fix a small conceptual issue and add details for v23
Signed-off-by: Lucas Santos <lhs.santoss@gmail.com>
@vercel

vercelBot commented Jan 20, 2025

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for Git ↗︎

NameStatusPreviewUpdated (UTC)
nodejs-org✅ Ready (Inspect)Visit PreviewJan 20, 2025 10:42pm

@khaosdoctor
khaosdoctor marked this pull request as ready for review January 20, 2025 18:52
@khaosdoctor
khaosdoctor requested a review from a team as a code ownerJanuary 20, 2025 18:52
@khaosdoctor

Copy link
Copy Markdown
MemberAuthor

cc @nodejs/typescript

Comment threadapps/site/pages/en/learn/typescript/run-natively.md Outdated
Comment threadapps/site/pages/en/learn/typescript/run-natively.md Outdated
Comment threadapps/site/pages/en/learn/typescript/run-natively.md Outdated
Comment threadapps/site/pages/en/learn/typescript/run-natively.md Outdated

@AugustinMauroyAugustinMauroy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General note :

Comment threadapps/site/pages/en/learn/typescript/run-natively.md Outdated
khaosdoctorand others added 2 commits January 20, 2025 23:34
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>
@khaosdoctor

Copy link
Copy Markdown
MemberAuthor

General note :

Done! Also added a link to V23's --no-experimental-strip-types

@khaosdoctor

Copy link
Copy Markdown
MemberAuthor

It seems to be stuck apparently, I can't get any results from the checks back and it's blocking the merge 🤔

@mikeestomikeesto added the github_actions:pull-request Trigger Pull Request Checks label Jan 21, 2025
@github-actions

github-actionsBot commented Jan 21, 2025

Copy link
Copy Markdown
Contributor

Lighthouse Results

URLPerformanceAccessibilityBest PracticesSEOReport
/en🟢 99🟢 100🟢 100🟢 91🔗
/en/about🟢 100🟢 100🟢 100🟢 91🔗
/en/about/previous-releases🟢 99🟢 100🟢 100🟢 92🔗
/en/download🟢 95🟢 100🟢 100🟢 91🔗
/en/blog🟢 100🟢 100🟢 96🟢 92🔗

@github-actions

Copy link
Copy Markdown
Contributor

Unit Test Coverage Report

LinesStatementsBranchesFunctions
Coverage: 88%
87.47% (740/846)74.3% (240/323)86.58% (142/164)

Unit Test Report

TestsSkippedFailuresErrorsTime
1820 💤0 ❌0 🔥5.535s ⏱️

@khaosdoctor
khaosdoctor added this pull request to the merge queueJan 21, 2025
Merged via the queue into main with commit 95047b1Jan 21, 2025
@khaosdoctor
khaosdoctor deleted the doc-ts-with-node branch January 21, 2025 00:52
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@khaosdoctor@jakebailey@robpalme@himself65@araujogui@AugustinMauroy@mikeesto