reactjs / reactjs/react-docgen
TS Path aliases seem to break type output
Offen
Dieses Issue hat noch niemand übernommen.
typescript
- Vorherrschende Sprache
- TypeScript
- Sterne
- 3.8k
- Forks
- 316
- Ø Merge
- 5 Std. 7 Min.
- Gemergte PRs (30 T.)
- 4
Beschreibung
For example:
Works ✅
import { Theme } from '../themes/Theme'
export interface IconProps {
/** The color to use */
color?: keyof Theme['color']
}
Yikes! ❌
import { Theme } from @themes/Theme'
export interface IconProps {
/** The color to use */
color?: keyof Theme['color']
}
The bottom results in the following type annotation being output:
string | number | symbol instead of the expected 'primary' | 'secondary' | 'tertiary'
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
In der Issue wird keine Datei und kein Test genannt. Beginne damit, die Beispiele für relative-import und path-alias zu reproduzieren, und verfolge dann, wie die TypeScript-Typausgabe aufgelöst wird; erledigt ist die Aufgabe, wenn das Alias-Beispiel die erwartete Union 'primary' | 'secondary' | 'tertiary' statt string | number | symbol erzeugt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- documentation
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100