Microsoft/TypeScript

JSDoc @link masked URL hyperlinks too far

Open

#51.133 aberto em 8 de out. de 2022

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (6.726 forks)batch import
BugDomain: JSDocHelp Wanted

Métricas do repositório

Stars
 (48.455 stars)
Métricas de merge de PR
 (Mesclagem média 6d 17h) (9 fundiu PRs em 30d)

Description

Does this issue occur when all extensions are disabled?: Yes

  • VS Code Version:
Version: 1.73.0-insider
Commit: fad3a77833b9249158dfd88477114a06435e46a2
Date: 2022-10-07T05:18:21.081Z
Electron: 19.0.17
Chromium: 102.0.5005.167
Node.js: 16.14.2
V8: 10.2.154.15-electron.0
OS: Linux x64 5.10.0-18-amd64 snap
Sandboxed: Yes
  • OS Version: Debian 11

Steps to Reproduce:

  1. Create a TypeScript file.
  2. Paste the following content:
/**
 * @see {@link https://readthedocs.org/|READ THE DOCS}
 */
const foo = "Bar";

According to the documentation, the pipe (|) character is a valid separator, however instead VSC reaches past it, which changes the link and takes the user to a different page than intended.

{@link namepathOrURL}
[link text]{@link namepathOrURL}
{@link namepathOrURL|link text}
{@link namepathOrURL link text (after the first space)}

— https://jsdoc.app/tags-inline-link.html#syntax

image

Both a space ( ) and pipe (|) are valid delimiters here, but currently only space works.

Guia do colaborador

Direção de pesquisa
Inspecione o analisador JSDoc no código fonte do TypeScript para encontrar onde os URLs @link são processados e adicione suporte ao delimitador pipe (|) conforme a especificação JSDoc.
Pilha de tecnologia
typescript
Domain
backend
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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
TypeScriptGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60