microsoft / microsoft/TypeScript
Flag 'instanceof' expressions that are provably always true or false
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Go
- Star
- 111k
- Fork
- 14.3k
- Merge trung bình
- 1 ngày 19 giờ
- Pull request đã merge (30 ngày)
- 117
Mô tả
Suggestion
When refactoring code, TypeScript is generally very good at finding and reporting situations where existing code will break due to type changes. This allows "refactoring with confidence". This isn't surprising given that one of the primary goals of TypeScript is to "statically identify constructs that are likely to be errors".
There's one common case where TypeScript is "blind" and doesn't report errors when types are refactored. This case involves the use of the 'instanceof' operator. This operator can be used in situations where it makes no sense -- e.g. where the type specified on the LHS has no possible relation to the type specified on the RHS.
To help developers avoid this common programming error, I propose that TypeScript report an error for any 'instanceof' expression that is provably always true or false at compilation time. Any such expression will likely be unintended by the programmer and should be flagged as errors. At best, such operations represent unnecessary code that imposes runtime overhead.
Example
// ClassB is a subclass of ClassA.
class ClassA {}
class ClassB extends ClassA {}
// ClassC has nothing to do with either
// ClassA or ClassB.
class ClassC {
method1() {}
}
function function1(param1: ClassB) {
// Static analysis can prove this expression
// will always evaluate to false. It's a common
// source of programming errors, especially during
// refactoring.
if (param1 instanceof ClassC) {
// This call isn't even valid given that param1
// was declared as type ClassB.
param1.method1();
}
// Static analysis can prove this expression will
// always evaluate to true, so at best it's unnecessary
// runtime overhead and more commonly is a behavior
// that is unintended by the programmer.
if (param1 instanceof ClassA) {
// ...
}
}
Are there any legitimate uses of 'instanceof' where the result is statically provable to be true or false in all cases? I can't think of any, but it's possible I'm overlooking some specialized cases. If there are, this check could be added as an optional compiler switch to preserve the current behavior.
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 xem xét các ví dụ ClassA, ClassB và ClassC của issue, cùng với hành vi kiểm tra kiểu instanceof hiện có trong trình biên dịch TypeScript. Xác định cách chẩn đoán các trường hợp luôn đúng và luôn sai, bao gồm cả những ngoại lệ hợp lệ. Được xem là hoàn thành khi trình biên dịch báo cáo các trường hợp dự kiến, có độ bao phủ cho các ví dụ và vẫn giữ nguyên cách sử dụng instanceof hợp lệ.
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
- Lĩnh vực
- compilers
- 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
- 28/100