microsoft / microsoft/TypeScript
IntelliSense Parses JSDoc Namepath Part "module" as a Actual Module File Path
@sandersn is already working on this.
Since Apr 16, 2019.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
- VSCode Version: 1.34.0-insider
- OS Version: 10.14.3 (18D109)
- Does this issue occur when all extensions are disabled?: Yes
Background
JSDoc uses namepaths to link variables in documentation. If you use the @module block to contain variables, then referencing those variables requires using the module: part in your namepaths.
Problem
When using JSDoc namepaths involving the 'module' part, VSCode displays the module's file path within IntelliSense. I think as a result the signature's return value is also wrong, instead displaying the module's exported functions.
Screenshot of issue:
Is there a way to escape that module keyword? Or some way to write it so it works with VSCode? Using the full module namepath in JSDoc is required to reference types defined within module blocks, as described here https://github.com/jsdoc3/jsdoc/issues/969 and here https://github.com/jsdoc3/jsdoc/issues/1533.
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.
Assessment
This issue has not been assessed yet.