microsoft / microsoft/TypeScript

Annotations/IntelliSense gets lost with simple `&` and `|` joins or utilities

Open
#57,418 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Experience Enhancement Help Wanted Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

🔎 Search Terms

IntelliSense, comments, annotations, symbol annotation, utilities, utility, union, intersection

🕗 Version & Regression Information
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about annotations
⏯ Playground Link

https://www.typescriptlang.org/play?#code/KYDwDg9gTgLgBASwHY2FAZgQwMbDgMQgjgG8AoOOAegCoa4BBJOTJJCGTGBCZ9aOOgRQAzvDBQIYNDACecGlQqDhYgAqTpsWQC44AIyIAbYK2W16TFmw5cefASODZeAEzgSpM+YuVOXSK4aXtp6SACuALb6aGQAvmRkoJCwiChoWLhwAEKYUKTmdIzMrOyc3LyCAjAAFni1wu6eWnIKSpQNUEGa3npiUMgA5vGJAWJVEHqExAC8BZRUVHCSRkZwEABuaHAwxIPA8KW2FUjKQqIwwS26gphGTgA05ksra5vbu3D7hzbl9n7ONxXXpwAAsACYRklwNB4HJpAQiExXAB5KC5fJzAAU0zgADIcnkAJRwAA+iOI5Ixo14434EGRGKmSMCaIxcDm5AWLwgq3e+SOf1pcFcvAA5PAAO7QADWcDqUGAZ1Ulx6oVu92AT0o-iBarkenB2p2NUawPVACI6nyLVDFnBItA8C5ImATCA4KBMK6THAALQBwNB4OBxLwvAAJWAAEdwsJgAwYAAZUxiFFIYAAHgAKg84ABpYCyESekCoQIlmVFiDoODZjlwKuyGt1gB8DbUCGwMszylzygAoiBsEZwq4s02W7mC0WRK2yO28couZQ4ABtfNpGfFgC6foA-Hoo7H465M53uzm8-nW4u4Go8tw7ueuz3p0OR2Os4Xi9fb-PKDiDdZx3MNZARRMU0wNMM1xOZjzjRVINTGB0yzaY8zFc51H1WQxTJOAxV1QJzTkMV5zIMZ4AAK3CGDgGmPRkOg1DYKIBsV3tV5+WsMo7GFO4RGIUUkAlOBpSgOUFSVShsNVEIDQ1Jx4iAA

💻 Code
// follow Playground link to see behavior

export interface Foo {
  /** An annotation for first property */
  firstProperty: boolean
  /** An annotation for second property */
  secondProperty: number
}

export interface Bar {
  /** An annotation for the third property */
  thirdProperty: string
}

const foo: Foo = {
  // roll over to get annotation
  firstProperty: false,
  // roll over to get annotation
  secondProperty: 42
}

export type FooAndOrBar = (Foo & Bar) | Foo | Bar

const fooAndBar: FooAndOrBar = {
  // rollover annotations don't work here
  firstProperty: true,
  secondProperty: 2,
  thirdProperty: "hello"
}
🙁 Actual behavior

IntelliSense doesn't work on properties after running through & (intersections) with | (unions) or more complex type manipulation.

🙂 Expected behavior

I expected the annotation to "come along" with the symbol and appear in IntelliSense.

Additional information about the issue

No response

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

Start with the linked TypeScript Playground reproduction and compare property IntelliSense for Foo, Bar, and FooAndOrBar. Trace how annotations are preserved through the intersection and union types, then verify that rollover IntelliSense shows the expected annotations for all three properties.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers, developer-experience
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 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.