microsoft / microsoft/TypeScript
JSDoc param tag's default value parsing should support non-TS expressions
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.4k
- Merge medio
- 1g 19h
- PR unite (30g)
- 117
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia dal punto di ingresso del parsing di JSDoc @param e confronta l’AST riportato per [somebody=John Doe] con il nodo defaultValue richiesto. Il lavoro è completato quando le espressioni predefinite non TS vengono preservate come valori predefiniti, la descrizione non include più la parentesi quadra di chiusura né il testo del nome del parametro e la coverage verifica l’esempio.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, typescript
- Ambito
- compilers
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100