From c45dc657516a8ffeafa1677f21516b759bd2688f Mon Sep 17 00:00:00 2001
From: Eric Amodio <eamodio@gmail.com>
Date: Fri, 8 Jul 2022 16:46:16 -0400
Subject: [PATCH] Adds docs for web debugging
---
.vscode/tasks.json | 12 ++++++++++++
CONTRIBUTING.md | 26 +++++++++++++++++++++++++-
2 files changed, 37 insertions(+), 1 deletion(-)
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
index 69186df..de96ce8 100644
--- a/.vscode/tasks.json
+++ b/.vscode/tasks.json
@@ -42,6 +42,18 @@
"problemMatcher": ["$ts-checker-webpack-watch", "$ts-checker-eslint-webpack-watch"]
},
{
+ "label": "Run (local web)",
+ "type": "npm",
+ "script": "web",
+ "group": "test",
+ "isBackground": true,
+ "presentation": {
+ "group": "web",
+ "reveal": "never"
+ },
+ "problemMatcher": []
+ },
+ {
"label": "Run (vscode.dev)",
"group": "test",
"dependsOn": ["npm: web:serve", "npm: web:tunnel"],
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 148abae..efdc927 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -100,12 +100,36 @@ yarn run package
### Debugging
-#### Using VS Code
+#### Using VS Code (desktop)
1. Open the `vscode-gitlens` folder
2. Ensure the required [dependencies](#dependencies) are installed
3. Choose the `Watch & Run` launch configuration from the launch dropdown in the Run and Debug viewlet and press `F5`.
+#### Using VS Code (desktop webworker)
+
+1. Open the `vscode-gitlens` folder
+2. Ensure the required [dependencies](#dependencies) are installed
+3. Choose the `Watch & Run (web)` launch configuration from the launch dropdown in the Run and Debug viewlet and press `F5`.
+
+#### Using VS Code for the Web (locally)
+
+See https://code.visualstudio.com/api/extension-guides/web-extensions#test-your-web-extension-in-a-browser-using-vscodetestweb
+
+1. Open the `vscode-gitlens` folder
+2. Ensure the required [dependencies](#dependencies) are installed
+3. Run the `build` or `watch` task from the command palette
+4. Run the `Run (local web)` task from the command palette
+
+#### Using VS Code for the Web (vscode.dev)
+
+See https://code.visualstudio.com/api/extension-guides/web-extensions#test-your-web-extension-in-on-vscode.dev
+
+1. Open the `vscode-gitlens` folder
+2. Ensure the required [dependencies](#dependencies) are installed
+3. Run the `build` or `watch` task from the command palette
+4. Run the `Run (vscode.dev)` task from the command palette
+
### Change Log
The [Change Log](CHANGELOG.md) is updated manually and an entry should be added for each change. Changes are grouped in lists by `added`, `changed` or `fixed`.