gajus/eslint-plugin-jsdoc
Rule suggestion: enforce proper `@see` + `@link` syntax for hyperlinks
已關閉
#1,631 建立於 2026年1月20日
enhancementhelp wanted
倉庫指標
- 星標
- (1,227 顆星)
- PR 合併指標
- (平均合併 2天 8小時) (30 天內合併 10 個 PR)
描述
Motivation
As of filing, I know of two syntaxes for saying a user can @see a link:
- At-Linked:
@see {@link https://example.com|Example} - Markdown:
@see [Example](https://example.com)
For consistency's sake, I think it would be nice to have a lint rule to prefer one and auto-fix the other to it.
Current behavior
No lint rule enforces either.
Desired behavior
I'm not sure. The Markdown variant is fewer characters, but the At-Linked one seems to be more of a "proper" link through JSDoc @link, so perhaps that?
Both show up well in at least TypeScript's native intellisense. The Markdown variant isn't perfectly supported by VS Code's native syntax highlighter, but that strikes me as a bug and not a motivator for choosing one over the other.
Alternatives considered
🤷