microsoft / microsoft/TypeScript

resolve declaration extension assets as paths and directing users to the correct implementation

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

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

Awaiting More Feedback Suggestion
Ngôn ngữ chính
Go
Star
111k
Fork
14.4k
Merge trung bình
1 ngày 19 giờ
Pull request đã merge (30 ngày)
117

Mô tả

Suggestion

Resolve string paths with nodeJS for declaration assets. And allow the resolution implementation to be directed to instead of the declaration file.

🔍 Search Terms

path resolution, custom declarations, assets, svg, png, jpg, webp, wav, mp4 etc.

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Add the ability to resolve custom declarations based on path within typescript directly.

  • This would make it much easier to fix issues with assets that are considered typescript strings.
  • Would not require third party plugins such as https://www.npmjs.com/package/eslint-plugin-validate-declared-imports
  • It should support tsconfig paths.
  • Validation should be done when running tsc. It should output an error when a string that is flagged as an asset is not resolvable.

Add the ability to go directly to the file now that string paths are being resolved as potential files

Add the ability to define which asset extensions in declarations are resolvable

  • would allow declarations to be able to say if the declaration is an asset and if it can be resolved.
  • Some assets like .mp4 should not be opened in most IDEs. But assets like svgs (and other files) would benefit from having this option.

This would prevent declaration path matching from causing runtime problems due to the assets missing and not being validated with tsc.

Related issues on Stack Overflow:

📃 Motivating Example

Adding this feature will prevent runtime issues with missing assets due to typos or changes in a codebase. This allows developers to directly import assets that are considered strings in typescript and retain file path validation for those new assets.

Adding this feature will also speed up development process when assets need to be tweaked. Example SVGs can be mutated in the VSCode IDE but clicking on an imported svg will redirect the user to a declaration instead of the asset implementation. Directing the user to the asset implementation would speedup things for everyone.

💻 Use Cases

  1. Prevent runtime issues related to assets path not matching and/or having typos in a path and typescript ignoring those typos due to the path being considered a pure string.
  2. Stabilizes the code even for external solutions that use imports.

I want to use this feature for any project that requires a asset to be declared as a string asset in a declaration file and resolve the asset extension using typescript directly instead of third party linting plugins such as eslint.

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 đọc entry point của trình biên dịch TypeScript tsc và hành vi hiện có về phân giải đường dẫn cho các tệp khai báo và tsconfig. Issue không nêu tệp hoặc test nào trong repository; để hoàn thành sẽ cần một thiết kế được xác định và việc validation cho các phần mở rộng asset, các đích phân giải và các chẩn đoán đối với asset bị thiếu.

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

Đánh giá

Công nghệ
typescript
Lĩnh vực
compilers
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
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
20/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.