microsoft / microsoft/TypeScript
JSDoc support for @yields
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
It would be nice to be able to use the @yields JSDoc tag.
We work with JS and JSDoc, but taking advantage of TSC and VSCode.
We also use the valid-jsdoc eslint rule.
We have:
/** @typedef Thing (...) */
function* walkThings() {
//... some yield here and there
}
We want to
/**
* @yields {Thing}
*/
function* walkThings() {
//... some yield here and there
}
We can't do
/**
* @returns {IterableIterator<Something>}
*/
function* walkThings() {
//... some yield here and there
}
Because it doesn't return, but yields, and eslint complains about it. We can disable the rule here, but it is not the desirable scenario.
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
No se nombra ningún archivo del repositorio ni ninguna prueba. Empieza rastreando el manejo existente de JSDoc de TypeScript para las funciones generadoras y @returns, y compáralo después con el ejemplo @yields {Thing}. Se considera terminado cuando la etiqueta se acepta con el tipo producido previsto y está cubierta por pruebas específicas.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- compilers, developer-experience
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 48/100