airbnb / airbnb/javascript

Documentation conflicts with object-property-newline setting?

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

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

pull request wanted
Ngôn ngữ chính
JavaScript
Star
148k
Fork
26.6k
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

It seems like the documentation consistently promotes having a new line for each item in multiline lists, whether it be in a function invocation or in an array (both of which mention bad examples of not having each item on a new line).

And even the object examples (although not referring to this specific rule) seem to favor this approach.

With that said, what is the reasoning behind allowing object properties to all appear on the same line?

It would seem more consistent to remove that option for object-property-newline. But at the very least, the reasoning and/or use case should probably be documented.

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 với packages/eslint-config-airbnb-base/rules/style.js tại cấu hình object-property-newline, sau đó so sánh tùy chọn của nó với các phần functions, arrays và object có liên kết trong style guide. Xác định liệu style guide nên giải thích tùy chọn này hay cấu hình nên được làm cho nhất quán, rồi ghi lại hành vi đã chọn và lý do.

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

Đánh giá

Công nghệ
eslint, javascript
Lĩnh vực
documentation, tooling
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
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
42/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.