Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vertical pipe characters should terminate URLs #232460

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

duncpro
Copy link
Contributor

@duncpro duncpro commented Oct 29, 2024

The vertical pipe character | is neither reserved nor unreserved under RFC 3986: Uniform Resource Identifiers and therefore it cannot appear within a URI.

However, linkComputer.ts does not list the vertical pipe character under FORCE_TERMINATION_CHARACTERS.

This makes VSCode's link-opening feature unusable in some circumstances since the vertical bar gets erroneously included in the URL, rendering it invalid. See #225513 for one example.

Note that this issue was reported earlier in #86358, and fixed improperly in this commit.

This pull request adds the vertical bar to the FORCE_TERMINATION_CHARACTERS, fixing the issue. It also reverts the change made in the other commit.

Testing

See the test case provided in #225513. After this commit VSCode behaves correctly.

Closes #225513

@mjbvz mjbvz assigned jrieken and alexdima and unassigned mjbvz Oct 29, 2024
@jrieken jrieken removed their assignment Oct 30, 2024
@duncpro
Copy link
Contributor Author

duncpro commented Nov 8, 2024

@alexdima Please take a look

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Cmd-Click doesn't work on JSDoc {@link URL|LinkText} format
4 participants