microsoft / microsoft/TypeScript
jsDoc intellisense support for @typedef in another file
Nessuno ha ancora preso questa issue.
- Lingua principale
- Go
- Stelle
- 111k
- Fork
- 14.3k
- Merge medio
- 2g 4h
- PR unite (30g)
- 132
Descrizione
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
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Riproduci il problema con i typedefs Configuration.js forniti e un consumer module.exports separato, prima con il file dei typedef aperto e poi chiuso. Traccia la scoperta di JSDoc @typedef da parte del servizio linguistico JavaScript e fai in modo che il consumer risolva quei tipi nell’intera directory di lavoro corrente; il lavoro è completato quando IntelliSense mostra i membri dei typedef in entrambi i casi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- javascript, typescript
- Ambito
- tooling
- Tipo di issue
- Funzionalità
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100