Browse Source

Adds docs for web debugging

main
Eric Amodio 2 years ago
parent
commit
c45dc65751
2 changed files with 37 additions and 1 deletions
  1. +12
    -0
      .vscode/tasks.json
  2. +25
    -1
      CONTRIBUTING.md

+ 12
- 0
.vscode/tasks.json View File

@ -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"],

+ 25
- 1
CONTRIBUTING.md View File

@ -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`.

||||||
x
 
000:0
Loading…
Cancel
Save