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

Aberta
#54,863 0 comentários 1 reação 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
20/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
typescript
Domínio
compilers

Direção de pesquisa

Comece lendo o ponto de entrada do compilador TypeScript tsc e o comportamento existente de resolução de caminhos para arquivos de declaração e tsconfig. A issue não especifica arquivos nem testes do repositório; para concluí-la, seria necessário definir um design e uma validação para extensões de assets, alvos de resolução e diagnósticos de assets ausentes.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
Go
Estrelas
111k
Forks
14.4k
Merge médio
1d 19h
PRs com merge (30d)
117

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de microsoft/TypeScript

Todas as issues de microsoft/TypeScript

Issues semelhantes

Mais issues de Go

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.