Skip to content

Commit a75b049

Browse files
committed
docs: update readme
1 parent 6da0ab1 commit a75b049

5 files changed

Lines changed: 80 additions & 21 deletions

File tree

.github/dependabot.yml

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: npm
4+
directory: '/'
5+
schedule:
6+
interval: weekly
7+
time: '11:00'
8+
open-pull-requests-limit: 10
9+
versioning-strategy: increase-if-necessary
10+
ignore:
11+
# updates to Node.js requires update to .nvmrc
12+
- dependency-name: '@types/node'
13+
update-types: ['version-update:semver-major']
14+
groups:
15+
patch-deps-updates-main:
16+
update-types:
17+
- 'patch'
18+
minor-deps-updates-main:
19+
update-types:
20+
- 'minor'
21+
major-deps-updates-main:
22+
update-types:
23+
- 'major'
24+
- package-ecosystem: github-actions
25+
directory: '/'
26+
schedule:
27+
interval: weekly
28+
time: '11:00'
29+
open-pull-requests-limit: 10
30+
groups:
31+
patch-deps-updates:
32+
update-types:
33+
- 'patch'
34+
minor-deps-updates:
35+
update-types:
36+
- 'minor'
37+
major-deps-updates:
38+
update-types:
39+
- 'major'

README.md

Lines changed: 41 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,67 @@
11
<h1 align="center">WebdriverIO extension for Visual Studio Code.</h1>
22

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+
37
## Features
48

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.
611

712
## Requirements
813

914
- Visual Studio Code version >= 1.98.0
1015
- WebdriverIO version >= v9.0.0
1116
- Node.js version >= 18.0.0 (follows WebdriverIO)
1217

13-
## 🚧🚧 Extension Settings 🚧🚧
18+
## Usage
1419

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.
1621

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.
1824

19-
This extension contributes the following settings:
25+
### Testing view
26+
27+
![Testing view](./assets/testing-view.png 'Testing view')
2028

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:
2330

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.
2535

26-
Calling out known issues can help limit users opening duplicate issues against your extension.
36+
Icons next to each test indicate their status
2737

28-
---
38+
- passed (checkmark)
39+
- failed (cross)
40+
- skipped (arrow)
41+
- running or loading (spinner)
42+
- not executed (dot)
2943

30-
## 🚧🚧 Following extension guidelines 🚧🚧
44+
### Test File
3145

32-
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
46+
![Test File](./assets/testing-file.png 'Test File')
3347

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.
3549

36-
## 🚧🚧 Working with Markdown 🚧🚧
50+
You can do the following actions:
3751

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.
3956

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
4358

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:
4564

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

assets/testing-file.png

94.3 KB
Loading

assets/testing-view.png

26.7 KB
Loading

assets/vscode-webdriverio.png

54.6 KB
Loading

0 commit comments

Comments
 (0)