microsoft / microsoft/TypeScript
@import suggestions for auto-imports in VS Code
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
🔍 Search Terms
@import, auto-import, JSDoc
✅ Viability Checklist
- 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 isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
Taken from a chat with @andrewbranch:
When working a JS codebase, it's common to want to import types. As of TS 5.5 we have the JSDoc @import tag which is wonderful!
However, VS Code does not offer it as an option for auto imports. Consider the following help menu:
I like the Change 'Customer' to 'import... suggestion, what I'd like even more would be a suggestion to Add /** @import {Customer} from ...
📃 Motivating Example
It doesn't improve the language. It improves the developer experience of JSDoc.
💻 Use Cases
- What do you want to use this for?
Working in VS Code more effectively. - What shortcomings exist with current approaches?
Current suggestions are more verbose. - What workarounds are you using in the meantime?
Writing imports by hand.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con el menú de ayuda de autoimportación existente de VS Code y la sugerencia “Change 'Customer'...” descrita en el issue. Traza cómo se produce esa sugerencia para los archivos JavaScript, añade después una opción JSDoc @import correspondiente y verifica que aparezca para el caso de importación de tipos que motiva el issue.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript, vscode
- Área
- developer-experience, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100