TypeScript: Missing Union Elements of Indexed Access Type

Đang mở
#906 0 bình luận 4 reaction 0 người được giao Xem trên GitHub

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
45/100
Loại issue
Lỗi
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
react, typescript
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

Bắt đầu với ví dụ TypeScript trong issue và tái hiện nó trong react-docgen playground. Theo dõi cách indexed-access type được xử lý, sau đó bổ sung coverage cho các phần tử literal của union như mong đợi và xác nhận rằng JSON được tạo ra có chứa ba literal được hiển thị.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

typescript

Hello there,
In the following code, the elements of the size props are not outputted.

type Base = {
  size: "small" | "medium" | "large";  
};

type Props = {
  size: Base["size"];
}

const MyComponent = ({size}: Props) => {
  return <div />;
}

Result

[
  {
    "description": "",
    "displayName": "MyComponent",
    "methods": [],
    "props": {
      "size": {
        "required": true,
        "tsType": {
          "name": "union",
          "raw": "Base[\"size\"]"
        },
        "description": ""
      }
    }
  }
]

Expected Behavior

[
  {
    "description": "",
    "displayName": "MyComponent",
    "methods": [],
    "props": {
      "size": {
        "required": true,
        "tsType": {
          "name": "union",
          "raw": "\"small\" | \"medium\" | \"large\"",
          "elements": [
            {
              "name": "literal",
              "value": "\"small\""
            },
            {
              "name": "literal",
              "value": "\"medium\""
            },
            {
              "name": "literal",
              "value": "\"large\""
            }
          ]
        },
        "description": ""
      }
    }
  }
]

I reproduced it here:
https://react-docgen.dev/playground

Thanks for regards.

Ngôn ngữ chính
TypeScript
Star
3.8k
Fork
316
Merge trung bình
3 giờ 28 phút
Pull request đã merge (30 ngày)
6

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.

Issue khác của reactjs/react-docgen

Tất cả issue của reactjs/react-docgen

Issue tương tự

Thêm issue về TypeScript

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.