Create an explainer / hub page for type stripping (TypeScript) support
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 48/100
- Loại issue
- Tài liệu
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- node.js, typescript
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu bằng việc đọc hướng dẫn run-natively hiện có và phần type-stripping trong tài liệu API TypeScript của Node.js, sau đó so sánh với bài giải thích của bên thứ ba được liên kết để tìm các điểm còn thiếu. Công việc được xem là hoàn tất khi một trang tổng quan chính thức giải thích về type-stripping, đưa ra các ví dụ .ts ngắn, xác định các phiên bản Node.js được hỗ trợ, bao quát các câu hỏi thường gặp về cú pháp và kiểm tra kiểu, đồng thời liên kết đến các tài nguyên khác.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- JavaScript
- Star
- 29
- Fork
- 165
- Merge trung bình
- 1 ngày 18 giờ
- Pull request đã merge (30 ngày)
- 2
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của nodejs/learn
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 25/100
-
Add an issue template Đang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 65/100
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 45/100
Issue tương tự
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 70/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
mksglu/context-mode#1200 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
neondatabase/website#5944 ·
-
module: core
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
bigbluebutton/bigbluebutton#25849 ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 75/100
jaegertracing/jaeger-ui#4506 ·