microsoft / microsoft/TypeScript
jsdoc: Picks up @errors comment inside a code snippet inside jsdoc as a tag
Nobody has claimed this yet.
- 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
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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