gajus/eslint-plugin-jsdoc

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

Open

#1.631 geöffnet am 20. Jan. 2026

Auf GitHub ansehen
 (1 Kommentar) (4 Reaktionen) (0 zugewiesene Personen)JavaScript (172 Forks)github user discovery
enhancementhelp wanted

Repository-Metriken

Stars
 (1.215 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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

🤷

Contributor Guide

Research-Richtung
Untersuchen Sie die vorhandenen JSDoc Regeln im Plugin (z.B. `require description`, `check access`), um das Muster für die Implementierung einer neuen Regel zu verstehen. Erstellen Sie einen Prototyp einer Regel, die eine konsistente `@see` + `@link` Syntax erzwingt und dabei die automatische Korrekturfunktion berücksichtigt.
Tech Stack
javascript
Domain
developer experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
ESLintJSDoc
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70