microsoft / microsoft/TypeScript
jsDoc intellisense support for @typedef in another file
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.3k
- Merge moyen
- 2 j 4 h
- PR mergées (30 j)
- 132
Description
Issue Type: Feature Request
Intellisense uses @typedef tags in other files but only if the file is opened in current window. Please allow any typedef tag to be used inside current working directory even if file containing typedef is not opened.
Here is what i mean. I annotated a variable with type. This variable is exported directly with module.exports.

My typedef is in seperate file.
Configuration.js
/**
* @typedef {Object} ConfigurationInputDirectories
* @property {string} modules
* @property {string} layoutModules
* @property {string} standaloneScripts
* @property {string} standaloneStyles
* @property {string} libraryScripts
* @property {string} libraryStyles
* @property {string} markupTemplates
*/
/**
* @typedef {Object} ConfigurationOutputDirectories
* @property {string} pageScripts
* @property {string} vendorScripts
* @property {string} standaloneScripts
* @property {string} pageStyles
* @property {string} vendorStyles
* @property {string} standaloneStyles
* @property {string} markupFiles
*/
/**
* @typedef {Object} ConfigurationVendor
* @property {string} standardPath
* @property {string} minPath
*/
/**
* @typedef {Object} ConfigurationModule
* @property {string} layoutModule
* @property {string} markupTemplate
* @property {string[]} includeStandaloneScripts
* @property {string[]} includeStandaloneStyles
* @property {string[]} includeVendorScripts
* @property {string[]} includeVendorStyles
* @property {string[]} excludeStandaloneScripts
* @property {string[]} excludeStandaloneStyles
* @property {string[]} excludeVendorScripts
* @property {string[]} excludeVendorStyles
*/
/**
* @typedef {Object} ConfigurationLayoutModule
* @property {string} layoutModule
* @property {string} markupTemplate
* @property {string[]} includeStandaloneScripts
* @property {string[]} includeStandaloneStyles
* @property {string[]} includeVendorScripts
* @property {string[]} includeVendorStyles
* @property {string[]} excludeStandaloneScripts
* @property {string[]} excludeStandaloneStyles
* @property {string[]} excludeVendorScripts
* @property {string[]} excludeVendorStyles
*/
/**
* Represents configuration object for build process.
* @typedef {Object} Configuration
* @property {ConfigurationInputDirectories} inputDirectories
* @property {ConfigurationOutputDirectories} outputDirectories
* @property {Object.<string,ConfigurationVendor} vendorScripts
* @property {Object.<string,ConfigurationVendor>} vendorStyles
* @property {Object.<string,ConfigurationModule>} modules
* @property {Object.<string,ConfigurationLayoutModule>} layoutModules
* @property {string} defaultMarkupTemplate
* @property {string} contentPlaceHolder
* @property {string} nameDirectorySeperator
* @property {string[]} validLibraryEntryFileNames
* @property {string} moduleFileName
* @property {string} rootModuleFileName
* @property {string} systemjsPath
* @property {string} systemjsNamedRegistersPath
*/
When this file containing type definitions is open the intellisense/language service/or whatever you call it is recognizing this variable's type and intellisense displays the members when using this config variable. But when file is closed its type turns to any. It would be nice to see type informations from typedef tags even if files containing tags are closed.

VS Code version: Code 1.33.0 (0dd516dd412d42323fc3464531b1c715d51c4c1a, 2019-04-04T15:14:28.026Z)
OS version: Windows_NT x64 10.0.17134
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Reproduisez le problème avec les typedefs Configuration.js fournis et un consommateur module.exports distinct, d’abord avec le fichier de typedefs ouvert, puis fermé. Suivez la découverte de JSDoc @typedef par le service de langage JavaScript et faites en sorte que le consommateur résolve ces types dans l’ensemble du répertoire de travail actuel ; le travail est terminé lorsque IntelliSense affiche les membres des typedefs dans les deux cas.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- javascript, typescript
- Domaine
- tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 4/5
- Temps estimé
- 3-5 jours
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100