microsoft / microsoft/TypeScript

VSCode ignores JSDoc's @property when specify @typedef type in 1.43.2 and 1.44.0-insider

Ouverte
#37,714 0 commentaires 4 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Needs Investigation
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

Seems like VSCode ignores @property when specify type inside @typedef in 1.43.2 and 1.44.0-insider. It cause type hint to show not so correct type information and also not detected inside autocomplete/intellisense.

  • VSCode Version: 1.43.2 and 1.44.0-insider
  • OS Version: Ubuntu 18.04 x86_64

Steps to Reproduce:

  1. Create JSDoc type definition file, for example types.js.
  2. Import the type into form.js.
  3. Ensure the type hint for the specified JSDoc is working properly (no any) and the type is detected available inside autocomplete/intellisense.

Temporary Solution:

  • Remove type from @typedef, such us from @typedef {Object<string, any>} Person into @typedef Person.
  • Or, remove <string, any> from Object, such us @typedef {Object<string, any>} Person into @typedef {Object} Person.

Reproduce Repo: https://github.com/jeffryang24/sandbox/tree/master/javascript/vscode-jsdoc-type-hint-issue

Does this issue occur when all extensions are disabled?: Yes/No

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Reproduisez le rapport avec la sandbox liée, en utilisant ses exemples de types.js et form.js ainsi que les versions de VS Code indiquées dans le rapport ou un équivalent disponible. Suivez ensuite le traitement de la JSDoc TypeScript pour @typedef, @property et les types Object génériques ; le travail est considéré comme terminé lorsque les indications de type des propriétés et l’autocomplétion fonctionnent sans any et que la reproduction existante reste couverte par un test de régression.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript, typescript, vscode
Domaine
developer-experience, devtools
Type d'issue
Bug
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.