reactjs / reactjs/react-docgen

TS Path aliases seem to break type output

Open
#456 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

typescript
Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
5h 7m
Merged PRs (30d)
4

Description

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'

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file or test is named in the issue. Start by reproducing the relative-import and path-alias examples, then trace how the TypeScript type output is resolved; done means the alias example produces the expected 'primary' | 'secondary' | 'tertiary' union instead of string | number | symbol.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.