Skip to content

Allow reporting errors for unresolved @ link jsdoc tags #44200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mjbvz opened this issue May 21, 2021 · 0 comments
Open

Allow reporting errors for unresolved @ link jsdoc tags #44200

mjbvz opened this issue May 21, 2021 · 0 comments
Labels
In Discussion Not yet reached consensus Suggestion An idea for TypeScript

Comments

@mjbvz
Copy link
Contributor

mjbvz commented May 21, 2021

Suggestion

πŸ” Search Terms

  • jsdoc
  • @link

⭐ Suggestion

Add an option to report unresolved @link symbols in JSDoc comments.

This can help catch some simple mistakes and also alert the user to cases where our IntelliSense doesn't understand the jsdocs symbol

πŸ“ƒ Motivating Example

/**
 * {@link food} <- Should been an error here
 */
const foo = 12

πŸ’» Use Cases

We'd use this in vscode for both our main codebase and for our vscode.d.ts file.

I imagine this would also be quite useful for maintaining definitely typed

Related issues

@RyanCavanaugh RyanCavanaugh added In Discussion Not yet reached consensus Suggestion An idea for TypeScript labels May 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
In Discussion Not yet reached consensus Suggestion An idea for TypeScript
Projects
None yet
Development

No branches or pull requests

2 participants