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

Improve URL handling documentation #3004

Closed
sguillia opened this issue Aug 21, 2019 · 4 comments
Closed

Improve URL handling documentation #3004

sguillia opened this issue Aug 21, 2019 · 4 comments
Assignees

Comments

@sguillia
Copy link

sguillia commented Aug 21, 2019

The documentation for URL handlers is out of date.

From here:

On Windows and macOS, you can also open projects and files using the platform's URL handling mechanism

Linux support was added in microsoft/vscode#56727

The docs talk about vscode:// but vscode-insiders:// exists too. It is only mentioned here in the extension API docs.

I would like to have one place gathering all information:

  • Supported platforms (Windows, linux, macOS)
  • Supported schemes (vscode and vscode-insiders)
  • Ways to use URL handlers:
    • Open files with vscode://file
    • Trigger extensions with vscode://publisher.extensionName/...

Is there any other way to use URL handlers? Right now I'm not sure.

I browsed the issues to gather information:
microsoft/vscode#4883
microsoft/vscode#48528
microsoft/vscode#46256
microsoft/vscode#48426
microsoft/vscode#59244
microsoft/vscode#56727

Related to #791

Thank you

@gregvanl gregvanl self-assigned this Aug 21, 2019
@gregvanl gregvanl added this to the September 2019 milestone Aug 21, 2019
@gregvanl
Copy link

Hi @sguillia Thank you for pointing out the stale content.
From my commit, you can see that I opted not to add more description for triggering extensions via URL since it doesn't feel like an end user scenario and is primarily for extension authors.
I checked with the engineering team and did not find any other ways to use URL handlers beside the two you mention.

@sguillia
Copy link
Author

Thank you @gregvanl for the confirmation.

I am an extension author and I was looking for all ways to utilise URL handlers.

For reference, the scheme vscode-exploration:// also exists.

@sguillia
Copy link
Author

@gregvanl In microsoft/vscode#20289, I found another way to use the URL handlers.
Example to open an extension in the marketplace:

vscode:extension/ms-vscode.csharp

@westurner
Copy link

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

No branches or pull requests

3 participants