microsoft / microsoft/TypeScript
JSDoc : support @interface and @implements (and more)
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
I would like to re-open an issue: https://github.com/microsoft/TypeScript/issues/16142
As it is locked I am to open this new issue.
I personally do not like TypeScript as a language, I do however, like TypeScript as a tool for my JavaScript projects, hence why I would like more support for JSDoc.
Code
In a JavaScript file, with checkJs option :
/**
* @interface Something
*/
/**
* @function
* @name Something#hello
* @param {string} name
*/
/**
* @implements {Something}
*/
const something = {};
Actual behavior:
No error.
Expected behavior:
An error should be raised. It's important in checkJs mode as JavaScript doesn't have native interfaces.
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
Comienza con la ruta checkJs de TypeScript para el ejemplo de JavaScript e inspecciona cómo se interpretan actualmente las etiquetas JSDoc @interface, @implements y @function. Reproduce el ejemplo, define después los diagnósticos esperados para la implementación de la interfaz y verifícalos con las pruebas relevantes del compilador; se considerará terminado cuando checkJs informe del contrato de interfaz que falta.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- compilers, tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 32/100