microsoft / microsoft/TypeScript
allow inline intellisense comment on es6 export
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
intellisense export
Suggestion
allow inline intellisense documentation of es6 export, or at least propagate the intellisense comments of the exported package. currently nothing is exported (other than type definitions)
Use Cases
allows for index files for large libraries to have better descriptions of the sub-modules it contains.
current (working) approach is to use the old pre-es6 /** comment */export import x = requires("x")
Examples
/** promise fs based api and related quality-of-life helper functions */
import * as fs from "./fs";
export { fs };
the above intellisense comment doesn't propagate.
Checklist
My suggestion meets these guidelines:
- [ X] This wouldn't be a breaking change in existing TypeScript/JavaScript code
- [ X] This wouldn't change the runtime behavior of existing JavaScript code
- [ X] This could be implemented without emitting different JS based on the types of the expressions
- [ X] This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
- [ X] 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
Empieza por localizar el manejo del compilador TypeScript de los comentarios JSDoc o IntelliSense en las declaraciones de exportación ES6 y, a continuación, compáralo con el ejemplo proporcionado export { fs }. El trabajo estará terminado cuando la descripción inline se propague al paquete o módulo exportado sin cambiar el JavaScript emitido.
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
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100