microsoft / microsoft/TypeScript
Support import types in JSDoc links
Offen
Dieses Issue hat noch niemand übernommen.
Experience Enhancement
Suggestion
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 2 T. 4 Std.
- Gemergte PRs (30 T.)
- 132
Beschreibung
Bug Report
🔎 Search Terms
- JSDoc
- link / see
🕗 Version & Regression Information
4.3.0-dev.20210503
💻 Code
For some JavaScript:
// foo.js
export class Foo {}
// index.js
/**
* {@link import('./foo').Foo Foo}
*
* @param {import('./foo').Foo} foo
*/
function withFoo(foo) { }
🙁 Actual behavior
The parameter type is resolved but the @link is not
🙂 Expected behavior
Both links should be resolved
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit der JSDoc-Link-Verarbeitung für das Beispiel {@link import('./foo').Foo Foo} in index.js und vergleiche sie mit dem funktionierenden Fall @param {import('./foo').Foo} sowie dem exportierten Foo in foo.js. Als erledigt gilt die Aufgabe, wenn sowohl der Parametertyp als auch der JSDoc-Link zu Foo aufgelöst werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- javascript, typescript
- Bereich
- compilers
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100