Skip to content

Commit f933177

Browse files
authored
Merge #3693 docs: web-mode development steps
2 parents 19043f3 + 20f1ab6 commit f933177

File tree

2 files changed

+32
-26
lines changed

2 files changed

+32
-26
lines changed

.vscode/launch.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,13 @@
2424
"preLaunchTask": "watch"
2525
},
2626
{
27-
"name": "Attach to ASL Server",
28-
"type": "node",
29-
"request": "attach",
30-
"port": 6009,
31-
"restart": true,
32-
"outFiles": ["${workspaceRoot}/dist/src/stepFunctions/asl/**.js"]
33-
},
34-
{
35-
"name": "Attach to SSM Document Language Server",
36-
"type": "node",
37-
"request": "attach",
38-
"port": 6010,
39-
"restart": true,
40-
"outFiles": ["${workspaceRoot}/dist/src/ssmDocument/ssm/ssmServer.js"]
27+
"name": "Extension (web)",
28+
"type": "pwa-extensionHost",
29+
"debugWebWorkerHost": true,
30+
"request": "launch",
31+
"args": ["--extensionDevelopmentPath=${workspaceFolder}", "--extensionDevelopmentKind=web"],
32+
"outFiles": ["${workspaceFolder}/dist/**/*.js"],
33+
"preLaunchTask": "${defaultBuildTask}"
4134
},
4235
{
4336
"name": "Extension (webpack)",
@@ -147,13 +140,20 @@
147140
"preLaunchTask": "${defaultBuildTask}"
148141
},
149142
{
150-
"name": "Run Web Extension ",
151-
"type": "pwa-extensionHost",
152-
"debugWebWorkerHost": true,
153-
"request": "launch",
154-
"args": ["--extensionDevelopmentPath=${workspaceFolder}", "--extensionDevelopmentKind=web"],
155-
"outFiles": ["${workspaceFolder}/dist/**/*.js"],
156-
"preLaunchTask": "${defaultBuildTask}"
143+
"name": "Attach to ASL Server",
144+
"type": "node",
145+
"request": "attach",
146+
"port": 6009,
147+
"restart": true,
148+
"outFiles": ["${workspaceRoot}/dist/src/stepFunctions/asl/**.js"]
149+
},
150+
{
151+
"name": "Attach to SSM Document Language Server",
152+
"type": "node",
153+
"request": "attach",
154+
"port": 6010,
155+
"restart": true,
156+
"outFiles": ["${workspaceRoot}/dist/src/ssmDocument/ssm/ssmServer.js"]
157157
}
158158
],
159159
"compounds": [

CONTRIBUTING.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,15 +35,21 @@ Then clone the repository and install NPM packages:
3535

3636
### Run
3737

38-
You can run the extension from Visual Studio Code:
38+
To run the extension from VSCode as a Node.js app:
3939

4040
1. Select the Run panel from the sidebar.
4141
2. From the dropdown at the top of the Run pane, choose `Extension`.
42-
3. Press `F5` to launch a new instance of Visual Studio Code with the extension installed and the debugger attached.
42+
3. Press `F5` to launch a new instance of VSCode with the extension installed and the debugger attached.
43+
44+
To run the extension from VSCode in "web mode" (a browser app, or "PWA"):
45+
46+
1. Select the Run panel from the sidebar.
47+
2. From the dropdown at the top of the Run pane, choose `Extension (web)`.
48+
3. Press `F5` to launch a new instance of VSCode (web mode) with the extension installed and the debugger attached.
4349

4450
### Build
4551

46-
When you launch the extension or run tests from Visual Studio Code, it will automatically build the extension and watch for changes.
52+
When you launch the extension or run tests from VSCode, it will automatically build the extension and watch for changes.
4753

4854
You can also use these NPM tasks (see `npm run` for the full list):
4955

@@ -118,7 +124,7 @@ You can also use these NPM tasks (see `npm run` for the full list):
118124
See [TESTPLAN.md](./docs/TESTPLAN.md) to understand the project's test
119125
structure, mechanics and philosophy.
120126
121-
You can run tests directly from Visual Studio Code:
127+
You can run tests directly from VSCode:
122128
123129
1. Select `View > Debug`, or select the Debug pane from the sidebar.
124130
2. From the dropdown at the top of the Debug pane, select the `Extension Tests` configuration.
@@ -343,7 +349,7 @@ Webviews can be hot-reloaded (updated without restarting the extension) by runni
343349

344350
### Font generation
345351

346-
For extensions to contribute their own codicons, VS Code requires a font file as well as how that font maps to codicon IDs. The mapping is found in `package.json` under the `icons` contribution point. Icons located in `resources/icons` are stitched together at build-time into a single font, automatically adding mappings to `package.json`. More information can be found [here](docs/icons.md).
352+
For extensions to contribute their own codicons, VSCode requires a font file as well as how that font maps to codicon IDs. The mapping is found in `package.json` under the `icons` contribution point. Icons located in `resources/icons` are stitched together at build-time into a single font, automatically adding mappings to `package.json`. More information can be found [here](docs/icons.md).
347353

348354
As a simple example, let's say I wanted to add a new icon for CloudWatch log streams. I would do the following:
349355

0 commit comments

Comments
 (0)