microsoft / microsoft/TypeScript
JSDoc support for @yields
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
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.
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
Non viene indicato alcun file del repository né alcun test. Inizia tracciando la gestione JSDoc esistente di TypeScript per le funzioni generatore e @returns, quindi confrontala con l'esempio @yields {Thing}. Il lavoro è completato quando il tag viene accettato con il tipo prodotto previsto ed è coperto da test mirati.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, typescript
- Ambito
- compilers, developer-experience
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Tranquilla
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 48/100