reactjs / reactjs/react-docgen
TS Path aliases seem to break type output
Aperta
Nessuno ha ancora preso questa issue.
typescript
- Lingua principale
- TypeScript
- Stelle
- 3.8k
- Fork
- 316
- Merge medio
- 5h 7m
- PR unite (30g)
- 4
Descrizione
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'
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
Nell’issue non sono indicati né file né test. Inizia riproducendo gli esempi di relative-import e path-alias, quindi traccia come viene risolto l’output dei tipi TypeScript; il lavoro è completato quando l’esempio dell’alias produce l’unione prevista 'primary' | 'secondary' | 'tertiary' invece di string | number | symbol.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- typescript
- Ambito
- documentation
- Tipo di issue
- Bug
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100