|
1 | 1 | <h1 align="center">WebdriverIO extension for Visual Studio Code.</h1> |
2 | 2 |
|
| 3 | +<p align="center"> |
| 4 | + <a title="WebdriverIO extension for Visual Studio Code" href="https://github.com/webdriverio/vscode-webdriverio"><img src="./assets/vscode-webdriverio.png" alt="WebdriverIO extension for Visual Studio Code" width="50%" /></a> |
| 5 | +</p> |
| 6 | + |
3 | 7 | ## Features |
4 | 8 |
|
5 | | -- **Run**, WebdriverIO tests in Visual Studio Code. |
| 9 | +- **Run** WebdriverIO tests in Visual Studio Code. |
| 10 | +- **All of the frameworks supported by WebdriverIO** can be used with this extension. |
6 | 11 |
|
7 | 12 | ## Requirements |
8 | 13 |
|
9 | 14 | - Visual Studio Code version >= 1.98.0 |
10 | 15 | - WebdriverIO version >= v9.0.0 |
11 | 16 | - Node.js version >= 18.0.0 (follows WebdriverIO) |
12 | 17 |
|
13 | | -## 🚧🚧 Extension Settings 🚧🚧 |
| 18 | +## Usage |
14 | 19 |
|
15 | | -Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
| 20 | +You can manage tests both from the Testing view. |
16 | 21 |
|
17 | | -For example: |
| 22 | +The WebdriverIO uses vscode's `TestController' APIs to provide a unified testing experience.<br> |
| 23 | +You can read the official guides about how to run the tests in the VSCode Documentation. |
18 | 24 |
|
19 | | -This extension contributes the following settings: |
| 25 | +### Testing view |
| 26 | + |
| 27 | + |
20 | 28 |
|
21 | | -- `myExtension.enable`: Enable/disable this extension. |
22 | | -- `myExtension.thing`: Set to `blah` to do something. |
| 29 | +The toolbar at the top provides various commands to manage test execution: |
23 | 30 |
|
24 | | -## 🚧🚧 Known Issues 🚧🚧 |
| 31 | +- **Refresh Tests**: To reload your test suite, reflecting any new changes. |
| 32 | +- **Run All Tests**: To start testing all cases that are currently visible. |
| 33 | +- **Show Output**: To display detailed logs from test executions. |
| 34 | +- **Miscellaneous Settings**: To customize the Testing view, such as sorting and grouping tests. |
25 | 35 |
|
26 | | -Calling out known issues can help limit users opening duplicate issues against your extension. |
| 36 | +Icons next to each test indicate their status |
27 | 37 |
|
28 | | ---- |
| 38 | +- passed (checkmark) |
| 39 | +- failed (cross) |
| 40 | +- skipped (arrow) |
| 41 | +- running or loading (spinner) |
| 42 | +- not executed (dot) |
29 | 43 |
|
30 | | -## 🚧🚧 Following extension guidelines 🚧🚧 |
| 44 | +### Test File |
31 | 45 |
|
32 | | -Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension. |
| 46 | + |
33 | 47 |
|
34 | | -- [Extension Guidelines](https://code.visualstudio.com/api/references/extension-guidelines) |
| 48 | +When you open a test file, you could notice test icons in the gutter next to each test case. |
35 | 49 |
|
36 | | -## 🚧🚧 Working with Markdown 🚧🚧 |
| 50 | +You can do the following actions: |
37 | 51 |
|
38 | | -You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts: |
| 52 | +- **Run a Single Test:** Click the test icon next to a test case to run that specific test. |
| 53 | +- **More Options:** Right-click the test icon to open a context menu with additional options: |
| 54 | + - `Run Test`: Execute the selected test case. |
| 55 | + - `Reveal in Test Explorer`: Locate and highlight the test in the centralized Testing view. |
39 | 56 |
|
40 | | -- Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux). |
41 | | -- Toggle preview (`Shift+Cmd+V` on macOS or `Shift+Ctrl+V` on Windows and Linux). |
42 | | -- Press `Ctrl+Space` (Windows, Linux, macOS) to see a list of Markdown snippets. |
| 57 | +## Extension Settings |
43 | 58 |
|
44 | | -## 🚧🚧 For more information 🚧🚧 |
| 59 | +Include if your extension adds any VS Code settings through the `contributes.configuration` extension point. |
| 60 | + |
| 61 | +For example: |
| 62 | + |
| 63 | +This extension contributes the following settings: |
45 | 64 |
|
46 | | -- [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown) |
47 | | -- [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/) |
| 65 | +- `webdriverio.configFilePattern`: Glob pattern for WebdriverIO configuration file |
| 66 | +- `webdriverio.logLevel`: Set the logLevel |
| 67 | +- `webdriverio.showOutput`: Show WebdriverIO output in the test result when set `true` this option |
0 commit comments