Create an explainer / hub page for type stripping (TypeScript) support
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- node.js, typescript
- Domain
- documentation
Research direction
Start by reading the existing run-natively guide and the type-stripping section of the Node.js TypeScript API documentation, then compare the linked third-party explainer for gaps. Done means an official high-level page explains type stripping, shows quick .ts examples, identifies supported Node.js versions, covers syntax and type-checking FAQs, and links to further resources.
Written by the indexing model from the issue text.
Description
Enter your suggestions in details:
The new type stripping / TypeScript support in Node.js is very exciting. A lot of users are adopting the built-in support for both source code and tooling config files. 🚀
But, there isn't one single high-level, official resource that users can be pointed to to understand the unflagged support.
- https://nodejs.org/en/learn/typescript/run-natively is more of a runbook that shows how to use it, but doesn't explain much of the concepts. It's also out of date now that support is no longer experimental.
- https://satanacchio.hashnode.dev/everything-you-need-to-know-about-nodejs-type-stripping is not official. It feels weird pointing folks to a third party platform. It also has a lot of details on historical context and decision-making that users who just want to learn the high level of the feature wouldn't want to have to read through. (it is a great blog post on its own though!)
- https://nodejs.org/api/typescript.html#type-stripping is very technical and dives into the weeds of the module system.
Proposal: can the Node.js site have a page added dedicated to explaining type stripping at the high level? I'd imagine it could contain:
- What "type stripping" is
- Quick examples of running a
.tsfile - What versions of Node.js have it
- Quick FAQs such as un/not-yet-supported syntax and type checking
- Links to learn more on the official Node.js and TypeScript websites
Sibling issue to nodejs/learn#35, intentionally with as similar an issue body as possible.
- Dominant language
- JavaScript
- Stars
- 29
- Forks
- 165
- Avg merge
- 1d 18h
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from nodejs/learn
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
-
Difficulty 3/5 1-2 days Newbie friendliness 65/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
Similar issues
-
ai-observability bug team/ai-observability
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
AllTheMods/ATM-10-L#19 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
SignalK/n2k-signalk#345 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
JuliaPluto/PlutoPlotly.jl#72 ·