microsoft / microsoft/TypeScript
typedef imports should use default exports
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Search Terms
checkJs typedef import
Suggestion
When the module ./core.controller has a default export defined, I would like to be able to do:
/**
* @typedef { import("./core.controller") } Chart
*/
Instead of:
/**
* @typedef { import("./core.controller").Chart } Chart
*/
Use Cases
My file had defined export default Chart;.
TypeScript made me add a duplicate export, which I don't want to have to add
export {
Chart
};
This resulted in lots of extra code
It also took me an extremely long amount of time to figure out I needed to do this because the documentation did not mention this as a limitation.
Examples
Already shared in the above sections.
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, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
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 la sección de tipos de importación del manual de TypeScript y las formas existentes de importación de typedef de JSDoc que se muestran en el issue. Sigue cómo se representa y se prueba un módulo exportado por defecto, y confirma después que la forma de importación más corta se acepta sin requerir un export nombrado duplicado y que la documentación describe este comportamiento.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- compilers
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100