reactjs / reactjs/react-docgen
Infer displayName from function/class/variable name
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- TypeScript
- Star
- 3.8k
- Fork
- 316
- Merge trung bình
- 5 giờ 7 phút
- Pull request đã merge (30 ngày)
- 4
Mô tả
Is there a reason this wasn’t already included? Having a displayName with each description would be beneficial for tools that are using docgen without having to re-read the js file to detect the display name again.
This wasn’t that big of a deal with React.createClass or class extends React.Component since those are pretty limited call sites, but the stateless function components can get a bit gnarly in trying to infer their display names. The detection for these are already pretty solid in the #28 branch.
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 phát hiện tên component hàm không trạng thái của branch #28 và theo dõi cách docgen xây dựng từng mô tả. Xác định nơi tên hàm, lớp hoặc biến được suy luận có thể trở thành các giá trị displayName, sau đó xác minh rằng các công cụ có thể sử dụng chúng mà không cần đọc lại tệp JS. Hoàn tất khi mỗi mô tả bao gồm displayName được suy luận cho các dạng component được hỗ trợ.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- react, typescript
- Lĩnh vực
- documentation
- 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