Merge branch 'main' of https://github.com/Microsoft/vscode-extension-samples

Author: jan-dolejsi

uri-handler-sample/.eslintrc.json

@@ -0,0 +1,19 @@
+{
+    "root": true,
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 6,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/naming-convention": "warn",
+        "@typescript-eslint/semi": "warn",
+        "curly": "warn",
+        "eqeqeq": "warn",
+        "no-throw-literal": "warn",
+        "semi": "off"
+    }
+}

uri-handler-sample/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+	// See http://go.microsoft.com/fwlink/?LinkId=827846
+	// for the documentation about the extensions.json format
+	"recommendations": [
+		"dbaeumer.vscode-eslint"
+	]
+}

uri-handler-sample/.vscode/launch.json

@@ -0,0 +1,34 @@
+// A launch configuration that compiles the extension and then opens it inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Run Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		},
+		{
+			"name": "Extension Tests",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/test/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		}
+	]
+}

uri-handler-sample/.vscode/settings.json

@@ -0,0 +1,11 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+    "files.exclude": {
+        "out": false // set this to true to hide the "out" folder with the compiled JS files
+    },
+    "search.exclude": {
+        "out": true // set this to false to include "out" folder in search results
+    },
+    // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+    "typescript.tsc.autoDetect": "off"
+}

uri-handler-sample/.vscode/tasks.json

@@ -0,0 +1,20 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "watch",
+			"problemMatcher": "$tsc-watch",
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never"
+			},
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			}
+		}
+	]
+}

uri-handler-sample/README.md

@@ -0,0 +1,42 @@
+# 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](https://code.visualstudio.com/api/references/vscode-api) 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