Microsoft/TypeScript

JSDoc @link masked URL hyperlinks too far

Open

#51 133 ouverte le 8 oct. 2022

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)TypeScript (6 726 forks)batch import
BugDomain: JSDocHelp Wanted

Métriques du dépôt

Stars
 (48 455 stars)
Métriques de merge PR
 (Merge moyen 6j 17h) (9 PRs mergées en 30 j)

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.

Guide contributeur

Direction de recherche
Inspectez l'analyseur JSDoc dans le code source de TypeScript pour trouver où les URL @link sont traitées, et ajoutez la prise en charge du délimiteur pipe (|) conformément à la spécification JSDoc.
Stack technique
typescript
Domaine
backend
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
TypeScriptGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60