microsoft / microsoft/TypeScript
Support JSDoc `@function`
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.3k
- Merge medio
- 2 d 4 h
- PR fusionados (30 d)
- 132
Descripción
From: https://github.com/Microsoft/vscode/issues/21321
TypeScript Version: 2.2.1 / nightly (2.2.0-dev.201xxxxx)
Code
// test-module.d.ts
declare module 'test-module' {
declare function func<T>(c: T): (y: any) => any;
}
// example.js
import { func } from 'test-module';
/**
* @function
* @param {number} c first number
* @returns {number} result
*/
const thisDoesNot = func(1);
Expected behavior:
The JSDoc specifications give thisDoesNot a type of (c: number) => number
Actual behavior:
The type from the *.d.ts file is preferred instead, giving thisDoesNot a type of (c: any) => any
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
Reproduce el problema con los fragmentos mostrados de test-module.d.ts y example.js y, a continuación, siga el procesamiento de JSDoc @function de TypeScript y cómo se seleccionan los tipos de declaraciones importadas. El trabajo estará terminado cuando las anotaciones JSDoc produzcan (c: number) => number para thisDoesNot sin provocar regresiones en la tipificación normal de los archivos de declaración.
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
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100