TS Path aliases seem to break type output

Abierto
#456 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
35/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
typescript
Área
documentation

Línea de trabajo

El issue no nombra ningún archivo ni prueba. Empieza reproduciendo los ejemplos de relative-import y path-alias, y luego rastrea cómo se resuelve la salida de tipos de TypeScript; se considera terminado cuando el ejemplo de alias produce la unión esperada 'primary' | 'secondary' | 'tertiary' en lugar de string | number | symbol.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

typescript

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'

Lenguaje dominante
TypeScript
Estrellas
3.8k
Forks
316
Merge medio
3 h 28 min
PR fusionados (30 d)
6

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de reactjs/react-docgen

Todos los issues de reactjs/react-docgen

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.