microsoft / microsoft/TypeScript
Intersection type intellisense duplicates jsdoc, rather than overriding
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
- VSCode Version: 1.33.1
- OS Version: macOS 10.12.6
Does this issue occur when all extensions are disabled?: Yes
Sorry if the title isn't clear, it's tricky to put into words but obvious with code. The gist is when a type is extended and has the same key, the intellisense combines the documentation, rather than the "child" overriding it, like they do with interface. It's easier to explain with an example.
When intersecting types with the same property, the intellisense documentation shows all of the comments instead of just the latest:
type Duck {
/** This is a really great duck */
id: string
}
type Mallard = Duck & {
/** I love this duck */
id: string
}
const duckMan: Mallard = {
id // intellisense here shows "This is a really great duck I love this duck"
}
However, with an interface, the intellisense shows only the direct type comment, which is expected.
interface Duck {
/** This is a really great banana */
id: string
}
interface Mallard extends Duck {
/** I love this duck */
id: string
}
const duckMan: Mallard = {
id // Intellisense says "I love this duck"
}
I found this out because I'm using graphql-codegen to generate types for my GraphQL schema. It generates types, and the intellisense in some cases repeats many times.
Expectation
I would expect the "closest" comment doc of a type to override all of the others, like it does with an interface. If there's a reason that can't work, then at least having a uniqueness check would be good, maybe new Set(typedocs))
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No source file or test is named. Start by reproducing the provided intersection-type and interface examples in TypeScript IntelliSense, then trace the language-service handling of JSDoc for intersected properties; done means the closest type's documentation is shown without duplicated inherited comments.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers, developer-experience
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100