Skip to content

Commit 1271e30

Browse files
author
Andreas Bartho
committed
Rewording parts of the README and moving images to docs/media
1 parent 9508bb3 commit 1271e30

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# electron-typescript-vscode
22

3-
This project provides a minimal working example of how to set up Visual Studio Code to develop an Electron app in Typescript, including debug support.
3+
The aim of this repository is to help setting up Visual Studio Code for development and debugging of Electron apps in Typescript.
44

5-
Visual Studio Code comes with Electron support and Typescript support out of the box, but bringing the two together requires some knowledge of the available configuration options that beginners may not have. This repository contains a Visual Studio Code project with the bare minimum configuration to show how Visual Studio Code, Node, Electron and Typescript must be configured to work together.
5+
Visual Studio Code comes with Electron support and Typescript support out of the box, but bringing the two together requires some advanced knowledge of the available configuration options. The repository contains a README with step by step instructions and an example project to demonstrate how Visual Studio Code, Node, Electron and Typescript must be configured to work together.
66

7-
The latest example has been created and tested on Linux with
7+
The latest example project has been created and tested on Linux with
88
- Node v15.13.0
99
- Electron v12.0.2
1010
- Typescript v4.2.3
@@ -32,13 +32,13 @@ npm start
3232

3333
It is required for debugging renderer processes.
3434

35-
![Debugger for Chrome](./doc/install_debugger_for_chrome.png)
35+
![Debugger for Chrome](./docs/media/install_debugger_for_chrome.png)
3636

3737
1) In the Run view, select the "Electron: All" configuration.
3838

3939
This is a compound configuration that will start both the "Electron: Main" and "Electron: Renderer" configurations.
4040

41-
![Select configuration](./doc/select_configuration.png)
41+
![Select configuration](./docs/media/select_configuration.png)
4242

4343
1) Set a breakpoint in `src/main.ts` and `src/renderer.ts`
4444

@@ -49,13 +49,13 @@ npm start
4949
- The breakpoint in `renderer.ts` should be hit.
5050

5151
- If the breakpoint is not hit and marked as unbound instead:
52-
![Disable Preview JavaScript Debugger](./doc/unbound_breakpoint.png)
52+
![Disable Preview JavaScript Debugger](./docs/media/unbound_breakpoint.png)
5353

54-
you have likely come across a bug in the new JavaScript debugger for Node.js and Chrome, which is currently in preview and enabled by default. It is used by recent versions of the "Debugger for Chrome" extension. Disabling the preview debugger will solve the problem (https://github.com/microsoft/vscode/issues/102493).
54+
you have likely come across a bug in the new JavaScript debugger for Node.js and Chrome, which is currently in preview and enabled by default. It is used by recent versions of the "Debugger for Chrome" extension. As a workaround, try to disable the preview debugger (https://github.com/microsoft/vscode/issues/102493).
5555
- Open Settings (<kbd>Ctrl+,</kbd>)
5656
- Search for `debug.javascript.usePreview`
5757
- Set option to false
58-
![Disable Preview JavaScript Debugger](./doc/disable_preview_javascript_debugger.png)
58+
![Disable Preview JavaScript Debugger](./docs/media/disable_preview_javascript_debugger.png)
5959
- Run the "Electron: All" configuration again
6060

6161

@@ -72,7 +72,7 @@ The launch configuration looks like this:
7272
```jsonc
7373
{
7474
"name": "Electron: Main",
75-
"type": "pwa-node", //use the node debugger that comes with VS Code
75+
"type": "pwa-node", //use the node debugger that comes with VS Code
7676
"request": "launch",
7777
"cwd": "${workspaceFolder}",
7878
"runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron",
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)