microsoft / microsoft/TypeScript

jsdoc: Picks up @errors comment inside a code snippet inside jsdoc as a tag

Open
#54,709 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: JSDoc Help Wanted Possible Improvement
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

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

https://ts-ast-viewer.com/#code/JYOwLgpgTgZghgYwgAgMoHsC2EAqALUAc2QG8AoASAoHoAqWyi5W5AQRGXQCMArCBMMgTpwcUEWQAvaOk5RkmdFBRwANsDgBnCJuQBXbQBNkYWcoAOqxCgBuavTuShkAA2CZzSsC+SawcSGxwTQA6ZHwdFXUtRzhlZDg9U0wA4AQ1VQBPZHMtIxNZADVgSASQYxxM8whUBChgczAQxmYWlhcOnk025GpqZAABaCglTQAuZDwIVVV0Hr7+mGBVCAnNG2nIEOEQJcIQrvm+kyrVpw8vAAoAcgH1zYgu6gBrEuuAShCAYRE9np2-EJfsBiABeUg9ZDIV5gCbkKjMKFItQacYQhEsJFI45gAi6ADuy1UCgCCDwCWQSxWkKxyGumEyAFoqRBrhNrrlcdRTNQGczlhADpprgAaNo0rE4vHIQkzElgMkUwzAZQCJTZODlJxgXQ7SDBCXY-qXFx85Wq0xQTLUAAePmUmnQqg2ulMrk5eG56F5TPN-Et1rt70NUPpvpV-vVbLpHq9PsZfrVVtF4oxtKhx01CWiugg5QkdBlRM4ICy8rJId6-VxKD1eZ1nBgSojScyIuQIHQghryETAe12lUMErYYTLYDdGjHICnp5ZvH6snhoAvjTV2nlwBuHodFyppgsAB84SmyC4emWYEZzhcABJ1FwfCitE5dSIwCMZhBjFxsi4dnsIQwiELKhA+T66CUr76PkMBKDkiDPHAhBEM0GI9MeACa6B6EWcogBA34FMgUB6BwLggOYmAkWRvYQDYPhungcAbGgGyqJAADSUGJMkqTpDM2SEHm0ABCgPbKAAjheyjGM+b67CCehQKkIhOORXQASCQoiD48EuDqWn7F0uloQegyGBA8B6BxpDrge1CMPJAD8EwAEr8EohgADx+PUICEO2flEIe27LkAA

As you can see, if you click on JSDoc part of tree, @errors is given its own tag, even thought it is inside

CleanShot 2023-06-20 at 00 02 00@2x

💻 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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue using the supplied playground link and the interface/JSDoc example in the report. Trace the JSDoc parsing path for fenced code blocks and verify that @errors inside the block is not emitted as a tag, while the actual @default tag remains recognized.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.