microsoft / microsoft/TypeScript
Investigate eagerly returning more information about suggestions
Chưa có ai nhận issue này.
- 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ả
Problem
Suggestions VS Code have three broad UX parts:
- Name/label. Primary identifier for a suggestion, such as
foo. - Details. Type information or auto import info, such as
string. - Documentation. Js doc info and additional details about the suggestion item
Currently VS Code only shows the details of the currently active suggestion. This can be problematic in cases like auto imports, where multiple symbols may all have the same name:
This design also reflects the design of the suggestion api:
completionInforeturns the entire list of suggestions, but only includes the namecompletionEntryDetailsreturns the details and documentation for an individual suggestion
Investigation
With https://github.com/microsoft/vscode/issues/39441, VS Code is exploring letting languages/extensions return the details part of the suggestion eagerly. This would let VS Code show details for the entire list of suggestions instead of just for the active one. In the auto import case specifically, this would likely mean showing the file paths we would import from.
We would like the typescript team's feedback on these idea and our current proposals:
- What information would be most helpful to render in the main suggestion list?
- How much overhead would returning this information add? Both in terms of message size and TS server computation time?
/cc @jrieken For VS Code apis
/cc @amcasey @minestarks for VS
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 bằng cách đọc issue này và issue #39441 của VS Code được liên kết, sau đó so sánh các API completionInfo và completionEntryDetails được mô tả ở đây. Điều tra những chi tiết gợi ý nào sẽ hữu ích trong danh sách chính, cũng như chi phí về kích thước thông báo và tính toán của máy chủ TypeScript. Được xem là hoàn thành khi đã ghi lại phản hồi của nhóm TypeScript hoặc đạt được một đề xuất rõ ràng.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- typescript, vscode
- Lĩnh vực
- developer-experience, tooling
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Cần làm rõ
- Mức phù hợp với người mới
- 25/100