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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Jump to bottom

Walkthrough markdown command links are broken #135505

Closed
filiptronicek opened this issue Oct 20, 2021 · 3 comments
Closed

Walkthrough markdown command links are broken #135505

filiptronicek opened this issue Oct 20, 2021 · 3 comments
Assignees
@JacksonKearl
Labels
bug Issue identified by VS Code Team member as probable bug getting-started important Issue identified as high-priority insiders-released Patch has been released in VS Code Insiders verified Verification succeeded
Milestone
October 2021

Comments

@filiptronicek
Copy link
Contributor

filiptronicek commented Oct 20, 2021 •
edited

Does this issue occur when all extensions are disabled? No - that's because no built-in walkthroughs have command links in their MD files 馃槃.

  • VS Code Version: 1.62.0-insider @ 2ae9352 (x64)
  • OS Version: Windows 11 (22478.1012)

Note about OS: tried in a web version of VS Code, this issue seems to be present as well (Linux backend), so I would go as far as to say it's universal.

Steps to Reproduce:

  1. Run the https://github.com/microsoft/vscode-extension-samples/tree/main/getting-started-sample sample extension in VS Code
  2. Open the extension walkthrough image
  3. Open the second to last item in the steps titled UI Platform: [current OS platform]
  4. Try clicking the Say hello link and realize that it has no href attribute. image (9)

It looks like VSC strips the command links from any walkthrough-linked markdown files. From what me and @mikenikles observed, this bug is just a couple of days/weeks old but reviewing recent commits I couldn't find one that would change something about this.
@filiptronicek filiptronicek mentioned this issue Oct 20, 2021
Closed
@yume-chan yume-chan mentioned this issue Oct 22, 2021
Closed
@JacksonKearl JacksonKearl added this to the October 2021 milestone Oct 22, 2021
@JacksonKearl
Copy link
Contributor

JacksonKearl commented Oct 22, 2021 •
edited

Thanks for pointing this out. Thanks to @yume-chan as well for correctly diagnosing this as a result of a change in markdown sanitizers a bit ago. I will provide a fix for this as soon as possible, sorry for any inconvenience.

@cyrilletuzi
Copy link

I confirm this issue, which has started with VS Code >= 1.61. Will the fix be available for the current version (1.61)? It is indeed quite a problem for extensions using the walkthrough feature as documentation for users, as quite a lot of the walkthroughs don't have much sense without those kind of links.

@cyrilletuzi
Copy link

I'll take the occasion to ask a question (as it may impact the fix too): is it possible to pass arguments in command: links? For example, command:walkthroughs.selectStep would be super useful to direct the user to a specific step of the walkthrough from another step, but the command requires an argument (the name step). I've looked everywhere but didn't find any documentation about this.

@JacksonKearl JacksonKearl added bug Issue identified by VS Code Team member as probable bug important Issue identified as high-priority labels Oct 25, 2021
@sandy081 sandy081 added the verified Verification succeeded label Oct 27, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Dec 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@JacksonKearl JacksonKearl

Labels
bug Issue identified by VS Code Team member as probable bug getting-started important Issue identified as high-priority insiders-released Patch has been released in VS Code Insiders verified Verification succeeded
Projects
None yet
Milestone
October 2021
Development

Successfully merging a pull request may close this issue.

Don't sanitize command URLs in getting started yume-chan/vscode
5 participants
@cyrilletuzi @JacksonKearl @sandy081 @filiptronicek and others