microsoft / microsoft/TypeScript

Suggest argument names based on type definition of callback functions

Đang mở
#40,335 1 bình luận 5 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Awaiting More Feedback 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

callback, arguments, parameters, suggestion, auto correct

Suggestion

Let's say I have a type definition for my function like this:

function acceptsCallback(callback: (argumentNameThatIsVeryLong: string) => void) {}

When using it, that argumentNameThatIsVeryLong is a very good candidate for my argument name. I want to accept it but there is no way but typing it:

Screen Shot 2020-08-31 at 5 22 34 PM

Use Cases

When users are extremely lazy this is very handy! ;) In all seriousness this can avoid bugs by suggesting the right argument name. For instance when req and res objects are misplaced in an Express middleware by mistake

Examples

https://www.typescriptlang.org/play?#code/GYVwdgxgLglg9mABAQwhApgBygZwMLIA2hARqgNYAUERpFAXIpcgE4DmIAtumFAHLJuAFQAWyKAEkcANXQsAngBkEbRjigsYYNgEpEAXgB8iAG5wYAEz0BvAL4Aoe6gzZ8tMhCqPv95ux32OkA

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

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Không có tệp triển khai hoặc bài kiểm thử nào được nêu. Hãy bắt đầu với ví dụ TypeScript Playground được liên kết và xem xét cách các gợi ý tham số callback hiện hoạt động trong trình soạn thảo. Được xem là hoàn tất khi tên các đối số từ một định nghĩa kiểu callback được cung cấp dưới dạng gợi ý mà không thay đổi JavaScript được phát ra.

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
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
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.