microsoft / microsoft/TypeScript
JSDoc param tag's default value parsing should support non-TS expressions
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
Suggestion
probably related to #44930 but a different use case. default values on @param: https://jsdoc.app/tags-param.html
🔍 Search Terms
jsdoc param default value
⭐ Suggestion
Please allow for default value params parsing
/**
* @param {string} [somebody=John Doe] - Somebody's name.
*/
export function sayHello(somebody) {
}
currently parses to tags:
[
{
name: "param",
text: [
{
text: "somebody",
kind: "parameterName"
},
{
text: " ",
kind: "space"
},
{
text: "Doe] - Somebody's name.",
kind: "text"
}
]
}
]
possibly add a new node
{
text: "John Doe",
kind: "defaultValue"
},
and clean up the description from
{
text: "Doe] - Somebody's name.",
kind: "text"
}
to
{
text: "- Somebody's name.",
kind: "text"
}
p.s. it mighy also be worth in general to clean up parameter descriptions text from the leading hyphen
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 en el punto de entrada del análisis de JSDoc @param y compara el AST informado para [somebody=John Doe] con el nodo defaultValue solicitado. Se considera terminado cuando las expresiones predeterminadas que no son de TS se conservan como valores predeterminados, la descripción ya no incluye el corchete de cierre ni el texto del nombre del parámetro, y la cobertura verifica el ejemplo.
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
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100