reactjs / reactjs/react-docgen

wrong `composes` for propType objects that are wrapped

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

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ả

Hello!

when defining prop types people do all sorts of things, for example:

import omit from 'lodash/omit';
import OtherComponent from 'important/path';

export default class Component extends React.PureComponent {
  propTypes = {
    ...omit(OtherComponent.propTypes, ['exclude', 'us']),
    something: bool
  };

  // ...
}
Expected

composes array is ['important/path']

Actual

composes array is ['lodash/omit']


i'm not even sure how this should be handled.
In example above it seems that extracting first argument from function
should be enough. But what if the composed prop types are not first
argument?

Should react-docgen support such cases at all? It seems valid to do so
from JS perspective but generated documentation is incomplete.

Recently https://github.com/reactjs/react-docgen/issues/248 was closed, so perhaps this issue should be considered too.

Thanks for the library!

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

Bắt đầu bằng cách lần theo cách react-docgen suy ra mảng composes từ các biểu thức prop-type được bao bọc, sử dụng ví dụ omit(OtherComponent.propTypes, ...) làm trường hợp tái hiện. So sánh kết quả important/path mong đợi với kết quả lodash/omit thực tế và xác định cách xử lý các đối số được compose không nằm ở vị trí đầu tiên. Hoàn thành khi hành vi đã được xác định và có kiểm thử bao phủ các trường hợp biểu thức được bao bọc đượ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ệ
javascript, react
Lĩnh vực
documentation
Loại issue
Lỗi
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
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
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.