gajus/eslint-plugin-jsdoc

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

Open

#1.631 aberto em 20 de jan. de 2026

Ver no GitHub
 (1 comment) (4 reactions) (0 assignees)JavaScript (172 forks)github user discovery
enhancementhelp wanted

Métricas do repositório

Stars
 (1.215 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

🤷

Guia do colaborador

Direção de pesquisa
Examine as regras JSDoc existentes no plugin (por exemplo, `require description`, `check access`) para entender o padrão de implementação de uma nova regra. Crie um protótipo de uma regra que force uma sintaxe consistente de `@see` + `@link`, considerando a capacidade de auto correção.
Pilha de tecnologia
javascript
Domain
developer experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
ESLintJSDoc
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70