Add support for web extension

VSpaceCode · Sep 17, 2021 · 3eb1d5e · 3eb1d5e
1 parent 84013ab
commit 3eb1d5e
Show file tree

Hide file tree

Showing 13 changed files with 3,532 additions and 299 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,5 @@ out
 dist
 node_modules
 .vscode-test/
+.vscode-test-web/
 *.vsix
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -3,34 +3,67 @@
 // 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",
-			"runtimeExecutable": "${execPath}",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}"
-			],
-			"outFiles": [
-				"${workspaceFolder}/dist/**/*.js"
-			],
-			"preLaunchTask": "npm: compile"
-		},
-		{
-			"name": "Extension Tests",
-			"type": "extensionHost",
-			"request": "launch",
-			"runtimeExecutable": "${execPath}",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
-			],
-			"outFiles": [
-				"${workspaceFolder}/out/test/**/*.js"
-			],
-			"preLaunchTask": "npm: test-compile"
-		}
-	]
+    "version": "0.1.0",
+    "configurations": [
+        {
+            "name": "Launch Extension",
+            "type": "extensionHost",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "args": [
+                "--extensionDevelopmentPath=${workspaceRoot}"
+            ],
+            "stopOnEntry": false,
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceFolder}/dist/**/*.js"
+            ],
+            "preLaunchTask": "npm: watch"
+        },
+        {
+            "name": "Launch Tests",
+            "type": "extensionHost",
+            "request": "launch",
+            "runtimeExecutable": "${execPath}",
+            "args": [
+                "--extensionDevelopmentPath=${workspaceRoot}",
+                "--extensionTestsPath=${workspaceRoot}/dist/test/suite/index-node"
+            ],
+            "stopOnEntry": false,
+            "sourceMaps": true,
+            "outFiles": [
+                "${workspaceFolder}/dist/**/*.js"
+            ],
+            "preLaunchTask": "npm: watch"
+        },
+        {
+            "name": "Run Web Extension in VS Code",
+            "type": "pwa-extensionHost",
+            "debugWebWorkerHost": true,
+            "request": "launch",
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}",
+                "--extensionDevelopmentKind=web"
+            ],
+            "outFiles": [
+                "${workspaceFolder}/dist/**/*.js"
+            ],
+            "preLaunchTask": "npm: watch"
+        },
+        {
+            "name": "Extension Tests in VS Code",
+            "type": "extensionHost",
+            "debugWebWorkerHost": true,
+            "request": "launch",
+            "args": [
+                "--extensionDevelopmentPath=${workspaceFolder}",
+                "--extensionDevelopmentKind=web",
+                "--extensionTestsPath=${workspaceFolder}/dist/test/suite/index-web"
+            ],
+            "outFiles": [
+                "${workspaceFolder}/dist/**/*.js"
+            ],
+            "preLaunchTask": "npm: watch"
+        }
+    ]
 }
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -3,18 +3,18 @@
 {
 	"version": "2.0.0",
 	"tasks": [
+		{
+			"type": "npm",
+			"script": "build",
+			"group": "build",
+			"problemMatcher": ["$ts-webpack", "$tslint-webpack"]
+		},
 		{
 			"type": "npm",
 			"script": "watch",
-			"problemMatcher": "$tsc-watch",
+			"group": "build",
 			"isBackground": true,
-			"presentation": {
-				"reveal": "never"
-			},
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			}
+			"problemMatcher": ["$ts-webpack-watch", "$tslint-webpack-watch"]
 		}
 	]
 }
diff --git a/.vscodeignore b/.vscodeignore
@@ -2,13 +2,16 @@
 
 .vscode/**
 .vscode-test/**
+.vscode-test-web/**
 
 **/*.ts
 **/*.map
 *.yml
 
 src/**
 out/**
+dist/test/**
+dist/**/*.map
 node_modules/**
 
 .gitignore

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,11 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add support for [web extension](https://code.visualstudio.com/api/extension-guides/web-extensions).
+
 ## [0.9.2] - 2021-06-27
 
 ### Changed
 
-- Add additional padding for icons
+- Add additional padding for icons.
 
 ## [0.9.1] - 2021-06-19
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -3,11 +3,13 @@
 Thank you for taking the time to contributing to vscode-which-key.
 
 ## First Time Setup
+
 1. Install prerequisites:
     - [Visual Studio Code](https://code.visualstudio.com/)
     - [Node.js](https://nodejs.org/)
 2. Fork the repository
 3. In a terminal
+
     ```sh
     # fork and clone the repository
     git clone [email protected]:<YOUR-FORK>/vscode-which-key.git
@@ -19,16 +21,21 @@ Thank you for taking the time to contributing to vscode-which-key.
     # Open in VSCode
     code .
     ```
-4. Go to debug tab select `Run Extension`
+
+4. Install [TypeScript + Webpack Problem Matchers for VS Code](https://marketplace.visualstudio.com/items?itemName=eamodio.tsl-problem-matcher)
+5. Go to debug tab select `Run Extension`
 
 ## Default binding menu
+
 The default bindings of `which-key` are separate from the `VSpaceCode`
 bindings. To see the bindings from the `package.json` in this repository, run
 "Which Key: Show Menu" from the command palette (`Ctrl-Alt-P`, or `SPC SPC`
 with `VSpaceCode`).
 
 ## Submitting Issues
+
 Feel free to open an issue if the issue you are experiencing is not in already in the [Github issues](https://github.com/VSpaceCode/vscode-which-key/issues).
 
 ## Submitting Pull Requests
+
 If you are submitting an pull request (PR) without a tracking issue, consider create an issue first. This is so that we can discuss different implementations if necessary.