Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cannot Get JSDoc React Component Summary in Intellisense #28753

Closed
ambroselittle opened this issue Jun 14, 2017 · 1 comment
Closed

Cannot Get JSDoc React Component Summary in Intellisense #28753

ambroselittle opened this issue Jun 14, 2017 · 1 comment
Assignees
Labels
upstream Issue identified as 'upstream' component related (exists outside of VS Code)

Comments

@ambroselittle
Copy link

  • VSCode Version: 1.13.1 (1.13.1)
  • OS Version: 10.12.5 (16F73)

Steps to Reproduce:

  1. Clone https://github.com/ambroselittle/vscode-intellisense-issue
  2. Open repo folder in Code.
  3. Open src/App.tsx.
  4. Hover over the imported TestComponent and/or try typing to add a new one.

Actual:
Just shows 'import ComponentName'. (This is true on my actual project as well, not just this simple repro.)
test-component1

Note that property docs work as expected:
some-prop

I've done my best to follow the docs, and I reviewed the JSDoc support. That last isn't very clear on if it's supported but seems to imply that just adding the /** Some summary doc. */ should work, as I've done in the repro.

Consider this a feature request if it's not implemented or tell me which to vote up, please. I really would like to provide some doc guidance for the shared components we have and have it show up there. Related: it'd be awesome to surface the specific JSX properties I specify at the top of the list so it's more obvious what the props are, not to mention showing right after <MyComponent + spacebar. (Again, plz advise if this is an existing request. I did try to search...)

@mjbvz mjbvz self-assigned this Jun 14, 2017
@mjbvz mjbvz added the upstream Issue identified as 'upstream' component related (exists outside of VS Code) label Jun 14, 2017
@mjbvz
Copy link
Collaborator

mjbvz commented Jun 14, 2017

Thanks. I believe you are running into microsoft/TypeScript#11099

The TypeScript service which powers our JS and TS language features currently does not handle intellsense for imports very well. The TypeScript team is looking into fixing this for TypeScript 2.5

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
upstream Issue identified as 'upstream' component related (exists outside of VS Code)
Projects
None yet
Development

No branches or pull requests

2 participants