gajus/eslint-plugin-jsdoc

Rule suggestion: enforce proper `@see` + `@link` syntax for hyperlinks

Open

#1631 aperta il 20 gen 2026

Vedi su GitHub
 (1 commento) (4 reazioni) (0 assegnatari)JavaScript (172 fork)github user discovery
enhancementhelp wanted

Metriche repository

Star
 (1215 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

🤷

Guida contributor

Direzione di ricerca
Esamina le regole JSDoc esistenti nel plugin (ad esempio `require description`, `check access`) per comprendere il pattern per implementare una nuova regola. Crea un prototipo di una regola che imponga una sintassi `@see` + `@link` coerente, considerando la capacità di auto correzione.
Tech stack
javascript
Dominio
developer experience
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
ESLintJSDoc
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70