Improve `getResolvedSiteConfigPath` error message logic

Đang mở Phù hợp với người mới
#210 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Lỗi
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
typescript
Lĩnh vực
build-system

Hướng nghiên cứu

Bắt đầu từ tools/webpack/utils/getResolvedSiteConfigPath.ts tại các dòng được liên kết và theo dõi cách SITE_CONFIG_PATH và defaultPath được kiểm tra. So sánh hành vi hiện tại với từng trường hợp trong bảng của issue, sau đó xác minh rằng đường dẫn được chọn và thông báo lỗi khớp với các kết quả đó.

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

Mô tả

When SITE_CONFIG_PATH is set but invalid, it silently falls through to try the default path instead of erroring immediately.

This means for the following flows:

SITE_CONFIG_PATH defined SITE_CONFIG_PATH exists defaultPath exists Result
✅ ✅ N/A No error. Site config path returned.
✅ ❌ ✅ No error. Default path returned.
✅ ❌ ❌ Error saying env var path is invalid, no mention of default path.
❌ ❌ ✅ No error. Default path returned.
❌ ❌ ❌ Error saying default path is invalid.

The main issue here is that the error messaging doesn't accurately reflect what's happening. No mention of falling back to the default path, and only showing the env var error message when both the env var path and the default path are invalid.

https://github.com/openedx/frontend-base/blob/d511970513aabcca86a9ae71c17c18779e9b514a/tools/webpack/utils/getResolvedSiteConfigPath.ts#L21-L26

Ngôn ngữ chính
TypeScript
Star
4
Fork
13
Merge trung bình
3 ngày 5 giờ
Pull request đã merge (30 ngày)
4

Chuẩn bị môi trường

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 openedx/frontend-base

Tất cả issue của openedx/frontend-base

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.