mirror of https://github.com/microsoft/vscode-extension-samples.git synced 2026-04-27 16:55:44 +08:00

Files

Matt Bierner 42e83bf2f3 Bump eslint versions and update lint scripts

Pick up latest eslint to avoid a nasty warning about using an unsupported version of TS

Also updates the eslint script to be more scoped on which files it checks

2022-11-04 13:52:32 -07:00

.vscode

Add URI handler sample (#405 )

2021-05-11 16:32:09 -07:00

src

Add URI handler sample (#405 )

2021-05-11 16:32:09 -07:00

.eslintrc.json

Add URI handler sample (#405 )

2021-05-11 16:32:09 -07:00

package-lock.json

Bump eslint versions and update lint scripts

2022-11-04 13:52:32 -07:00

package.json

Bump eslint versions and update lint scripts

2022-11-04 13:52:32 -07:00

README.md

Add URI handler sample (#405 )

2021-05-11 16:32:09 -07:00

tsconfig.json

Bump all targets to es2020

2022-02-28 13:45:21 -08:00

README.md

Uri Handlers

This sample demonstrates how to implement a Uri handler in VS Code. A Uri handler is run when a browser redirects to VS Code with a specific extension id as the authority.

Examples:

vscode://vscode-samples.uri-handler-sample
vscode-insiders://vscode-samples.uri-handler-sample

If you paste these Uris into your browser, they will open VS Code and VS Code insiders, respectively.

This sample provides a simple Uri handler that shows an information message when a Uri is handled. Additionally, if a query string was included in the Uri, it will include that in the message.

Run the sample and try opening the following Uris in your browser:

vscode://vscode-samples.uri-handler-sample
vscode://vscode-samples.uri-handler-sample?q=hello

Note: use vscode-insiders:// if you ran the sample in insiders.

VS Code API

This sample uses following APIs

APIs

window.registerUriHandler
env.uriScheme
env.asExternalUri
UriHandler

Be sure to look at the API Docs for usage.

Running the Sample

Open this example in VS Code Insiders
npm install
npm run watch
F5 to start debugging
Run the Start handling Uris command