Skip to content

Commit 0dd1d7e

Browse files
committed
fix up test and debug sections
1 parent 467ea00 commit 0dd1d7e

2 files changed

Lines changed: 17 additions & 20 deletions

File tree

README.md

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -132,23 +132,15 @@ You can identify the development version of Code by the Electron icon in the Doc
132132
means you didn't run `gulp watch` first.
133133

134134
### Debugging
135-
VS Code uses a multi process architecture and your code is executed in different
136-
processes:
137-
* the render process runs the UI code inside the Shell window
138-
* the plugin host process runs code implemented by a plugin
135+
Code has a multi-process architecture and your code is executed in different processes:
136+
* The **render** process runs the UI code inside the Shell window. To debug code running in the **renderer** process, launch the Chrome Developers Tools
137+
using the `Developer: Toggle Developer Tools` command from the Command Palette.
139138

140-
To debug code that runs in the renderer process you launch the Chrome Developers Tools using
141-
`Help | Toggle Developer Tools`.
142-
143-
To debug code that runs inside the plugin host process you open another instance of the Chrome
144-
Developer Tools using `Developer: Reveal Plugin Host Process` from the command palette.
145-
146-
**Tip!** When you are done debugging, use the 'Hide Window' button to close the Chrome Developer
147-
Tools on the Plugin Host Process, or use the command `Developer: Hide Plugin Host Process Window`.
148-
Do not close the window using the close button as this will also kill the plugin host process itself.
139+
* The **extension host** process runs code implemented by a plugin. To debug extensions (including those packaged with code) which run in the **extension host**
140+
process, you can use VS Code itself. Switch to the Debug viewlet, choose the
141+
`Attach to Extension Host` configuration, and press `F5`.
149142

150143
### Unit Testing
151144
Press `SHIFT+CMD+T` (`CTRL+SHIFT+T` on Windows) to start the unit tests or run the tests directly
152-
from a terminal using `gulp test`. The [test README.md](test/README.md) has complete details on
153-
how to run tests and coverage reports.
154-
145+
from a terminal by running `mocha` from the `vscode` folder. The [/test README](test/README.md) has complete details on
146+
how to run and debug tests, as well as how to produce coverage reports.

test/README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,24 @@
22

33
## Run
44

5-
You can run tests directly from the command line:
5+
The best way to run the Code tests is from within VS Code. Simply press
6+
`CMD+Shift+T` (`Ctrl+Shift+T` on Windows) to launch the tests.
67

8+
If you wish to run the tests from a terminal, from the `vscode` folder run:
9+
10+
cd vscode
711
mocha
812

9-
Alternatively, you can run them from any browser. Simply
10-
open the URL provided by the following command:
13+
Alternatively, you can run them from any browser. Simply open the URL
14+
provided by the following command:
1115

16+
cd vscode
1217
mocha --browser
1318

1419
## Debug
1520

1621
You can use VS Code to debug your tests. Switch to the Debug viewlet,
17-
pick the `Mocha` debug target and press `Play`.
22+
pick the `Unit Tests` debug target and press `Play`.
1823

1924
## Coverage
2025

0 commit comments

Comments
 (0)