microsoft / microsoft/TypeScript
jsdoc: Picks up @errors comment inside a code snippet inside jsdoc as a tag
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Bug Report
🔎 Search Terms
jsdoc @errors comment as tag inside code snippet
🕗 Version & Regression Information
I noticed after upgrading from 4.9.4 to 5.1.3
⏯ Playground Link
As you can see, if you click on JSDoc part of tree, @errors is given its own tag, even thought it is inside
💻 Code
interface SomeThing {
/**
* An object containing zero or more aliases used to replace values in `import` statements. These aliases are automatically passed to Vite and TypeScript.
*
* ```js
* // @errors: hello
* /// file: svelte.config.js
* /// type: import('@sveltejs/kit').Config
* const config = {
* kit: {
* alias: {
* // this will match a file
* 'my-file': 'path/to/my-file.js',
*
* // this will match a directory and its contents
* // (`my-directory/x` resolves to `path/to/my-directory/x`)
* 'my-directory': 'path/to/my-directory',
*
* // an alias ending /* will only match
* // the contents of a directory, not the directory itself
* 'my-directory/*': 'path/to/my-directory/*'
* }
* }
* };
* ```
*
* > The built-in `$lib` alias is controlled by `config.kit.files.lib` as it is used for packaging.
*
* > You will need to run `npm run dev` to have SvelteKit automatically generate the required alias configuration in `jsconfig.json` or `tsconfig.json`.
* @default {}
*/
alias?: Record<string, string>;
}
🙁 Actual behavior
@errors in the code snippet was marked as a JSDoc tag
🙂 Expected behavior
@errors is inside a code snippet, should not be parsed as a JSDoc tag at all
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 utilizando el enlace al playground proporcionado y el ejemplo de interface/JSDoc del informe. Sigue la ruta de análisis de JSDoc para los bloques de código delimitados y verifica que @errors dentro del bloque no se emita como una etiqueta, mientras que la etiqueta @default real siga reconociéndose.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- 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