microsoft / microsoft/TypeScript
Warn when JSDoc type cast misses parentheses
Đang mở
Chưa có ai nhận issue này.
Domain: JSDoc
In Discussion
Suggestion
- Ngôn ngữ chính
- Go
- Star
- 111k
- Fork
- 14.3k
- Merge trung bình
- 2 ngày 4 giờ
- Pull request đã merge (30 ngày)
- 132
Mô tả
Search Terms
jsdoc. type castSuggestion
JSDoc type cast currently requires parentheses for technical reasons (#18212), but it does not warn when they don't exist.
Use Cases
// This doesn't work, the JSDoc comment is silently ignored
// A warning message will help.
const img = /** @type {HTMLImageElement} */ document.getElementById('#cat')
img.src = 'cat.gif'
Examples
const img = /** @type {HTMLImageElement} */ document.getElementById('#cat')
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^ Warning: The JSDoc type cast misses parentheses and is being ignored
img.src = 'cat.gif'
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
- This wouldn't change the runtime behavior of existing JavaScript code
- This could be implemented without emitting different JS based on the types of the expressions
- This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
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.
Hướng nghiên cứu
Bắt đầu với việc xử lý ép kiểu JSDoc được mô tả trong issue và issue được tham chiếu #18212, sau đó tìm chẩn đoán và các bài kiểm thử hồi quy liên quan. Thay đổi được hoàn tất khi một phép ép kiểu thiếu dấu ngoặc đơn tạo ra cảnh báo được hiển thị mà không thay đổi đầu ra JavaScript, trong khi các phép ép kiểu có dấu ngoặc đơn vẫn giữ nguyên hành vi hiện tại.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- javascript, typescript
- Lĩnh vực
- compilers
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100