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

Aperta
#54,863 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
20/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
compilers

Direzione di ricerca

Inizia leggendo l’entry point del compilatore TypeScript tsc e il comportamento esistente di risoluzione dei percorsi per i file di dichiarazione e tsconfig. La issue non indica file o test del repository; per completarla sarebbero necessari un design definito e una validazione per le estensioni degli asset, le destinazioni di risoluzione e le diagnostiche per gli asset mancanti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Awaiting More Feedback Suggestion

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.

Lingua principale
Go
Stelle
111k
Fork
14.4k
Merge medio
1g 19h
PR unite (30g)
117

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di microsoft/TypeScript

Tutte le issue di microsoft/TypeScript

Issue simili

Altre issue su Go

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.