gajus/eslint-plugin-jsdoc

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

Open

#1 631 ouverte le 20 janv. 2026

Voir sur GitHub
 (1 commentaire) (4 réactions) (0 assignés)JavaScript (172 forks)github user discovery
enhancementhelp wanted

Métriques du dépôt

Stars
 (1 215 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

🤷

Guide contributeur

Direction de recherche
Examinez les règles JSDoc existantes dans le plugin (par exemple `require description`, `check access`) pour comprendre le modèle de mise en œuvre d'une nouvelle règle. Créez un prototype d'une règle qui impose une syntaxe cohérente `@see` + `@link`, en tenant compte de la capacité de correction automatique.
Stack technique
javascript
Domaine
developer experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
ESLintJSDoc
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70