microsoft / microsoft/TypeScript

IntelliSense Parses JSDoc Namepath Part "module" as a Actual Module File Path

Abierto
#30,893 1 comentario 0 reacciones 1 asignado Ver en GitHub

@sandersn ya está trabajando en esto.

Desde el 16/4/2019.

Needs Investigation
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

- 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:

Screen Shot 2019-04-12 at 12 44 19 PM

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.