microsoft / microsoft/TypeScript
Support import types in JSDoc links
Abierto
Nadie ha tomado este issue todavía.
Experience Enhancement
Suggestion
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Bug Report
🔎 Search Terms
- JSDoc
- link / see
🕗 Version & Regression Information
4.3.0-dev.20210503
💻 Code
For some JavaScript:
// foo.js
export class Foo {}
// index.js
/**
* {@link import('./foo').Foo Foo}
*
* @param {import('./foo').Foo} foo
*/
function withFoo(foo) { }
🙁 Actual behavior
The parameter type is resolved but the @link is not
🙂 Expected behavior
Both links should be resolved
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza por el manejo del enlace JSDoc del ejemplo {@link import('./foo').Foo Foo} en index.js, comparándolo con el caso funcional @param {import('./foo').Foo} y con el Foo exportado en foo.js. Se considera terminado cuando tanto el tipo del parámetro como el enlace JSDoc se resuelvan a Foo.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- compilers
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 45/100