Create an explainer / hub page for type stripping (TypeScript) support
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 48/100
- Issue 类型
- 文档
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- node.js, typescript
调研方向
首先阅读现有的 run-natively 指南以及 Node.js TypeScript API 文档中的 type-stripping 部分,然后对照链接的第三方解读,查找其中的不足。完成标准是一篇官方的高层级页面能够解释 type-stripping,展示简短的 .ts 示例,列出受支持的 Node.js 版本,涵盖有关语法和类型检查的常见问题,并链接到更多资源。
由索引模型根据 Issue 内容生成。
描述
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.
- 主要语言
- JavaScript
- 星标
- 29
- 派生
- 165
- 平均合并
- 10 天 12 小时
- 30 天内合并 PR
- 14
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
nodejs/learn 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 35/100
-
难度 3/5 1-2 天 新手友好度 65/100
-
难度 3/5 1-2 天 新手友好度 45/100
-
难度 3/5 1-2 天 新手友好度 72/100
-
难度 3/5 1-2 天 新手友好度 35/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 82/100
-
area-deployment area-integrations triage:bot-seen
难度 2/5 半天 新手友好度 86/100
-
Issue-Bug
难度 2/5 1-3 小时 新手友好度 68/100
sugarlabs/musicblocks#8924 ·
-
难度 1/5 1 小时以内 新手友好度 90/100
ArduPilot/ardupilot_wiki#8088 ·
-
[BUG] createTool tools cannot be registered with Mastra when exactOptionalPropertyTypes is enabled 未关闭customer-eng status: needs triage
难度 2/5 1-3 小时 新手友好度 84/100