Provide a reliable way to find the entrypoint path or URL
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- JavaScript
- Star
- 122k
- Fork
- 37.4k
- Merge trung bình
- 4 ngày 3 giờ
- Pull request đã merge (30 ngày)
- 272
Mô tả
What is the problem this feature will solve?
This solves the same problem as require.main.filename did in a CommonJS-only world: finding the entrypoint script for the Node.js process. This is most commonly used to determine the whether the current file is the entrypoint, but is also useful for various other sorts of introspection about the running Node.js environment. My specific use-case is finding a sensible default base URL to use to replicate Node.js's package resolution algorithm.
What is the feature you are proposing to solve the problem?
I suggest something like process.cliEntrypoint or process.cliMainUrl. I think it's important that any solution be usable regardless of whether the current module is CJS or ESM.
What alternatives have you considered?
require.main.filename provides this information but it doesn't work outside of CJS files, nor does it work if the entrypoint itself is ESM.
process.argv[1] sometimes provides this information, but it has a number of problems:
-
If the Node.js CLI is run without a file extension, like
node myappinstead ofnode myapp.js,process.argv[1]won't have an extension either. -
If the entrypoint is a symlink,
process.argv[1]will point to the symlink instead of the physical JS file. This differs from__filename, which means it also differs from the logic used byrequire(). Note thatnpm execalways creates a symlink when running executables. -
process.argvis mutable, so it's possible for unrelated code to modify it in such a way that it's no longer usable to find the entrypoint.
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
Không có tệp triển khai hoặc bài kiểm thử nào được nêu. Hãy bắt đầu bằng việc xem xét cách Node.js hiện xác định entrypoint của CLI cho CommonJS và ESM, bao gồm các phương án thay thế require.main.filename và process.argv[1] được mô tả ở đây. Được xem là hoàn tất khi một API ổn định hoạt động với cả hai hệ thống module và xử lý các đường dẫn không có phần mở rộng, symlink và những thay đổi sau đó đối với process.argv.
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, node.js
- Lĩnh vực
- backend
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100