https://github.com/elaichenkov/doorman
Doorman is a simple, lightweight VSCode extension that allows you to link and open test cases from your favourite test case management tool directly in VSCode.
https://github.com/elaichenkov/doorman
cypress cypress-io playwright testing vscode-extension
Last synced: 4 months ago
JSON representation
Doorman is a simple, lightweight VSCode extension that allows you to link and open test cases from your favourite test case management tool directly in VSCode.
- Host: GitHub
- URL: https://github.com/elaichenkov/doorman
- Owner: elaichenkov
- License: mit
- Created: 2023-09-28T14:45:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-03T10:47:15.000Z (over 1 year ago)
- Last Synced: 2025-04-09T17:14:47.755Z (about 1 year ago)
- Topics: cypress, cypress-io, playwright, testing, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=elaichenkov.doorman
- Size: 3.93 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Doorman
Doorman is a simple, lightweight VSCode extension that allows you to link and open test cases from your favorite test case management tool directly in VSCode.
## Features
- Link test cases from your test management tool directly in VSCode
- Open test cases in your default browser
- Supports multiple test management tools
- Supports multiple test case formats
## Extension Settings
This extension contributes the following settings:
- `doorman.configurations`: List of configurations for your test management tools and test case formats
- `doorman.configurations[].title`: Title of the configuration
- `doorman.configurations[].url`: URL of the test management tool
- `doorman.configurations[].testIdPattern`: Regular expression to match test case ID in the test case format
For example:
Your test management tool is TestRail and test case format is `[S123]`. So, your test looks like this:
```js
it('[S123] should verify the title', () => {
// ...
});
```
Then you can add the following configuration in your `.vscode/settings.json`:
```json
{
"doorman.configurations": [
{
"title": "🔗 Open test case in TestRail",
"url": "https://testrail.example.com/index.php?/cases/view/S",
"testIdPattern": "\\[S(\\d+)\\]"
}
]
}
```
After that you will see the following title in the code block:
By clicking on the title you will open the test case in your default browser.
The URL will be generated based on the configuration. In this case it will be `https://testrail.example.com/index.php?/cases/view/S123`.
There is some useful regular expressions for popular test case formats:
- `[S123]` - `\\[S(\\d+)\\]`
```js
it('[S123] should do something', () => {});
```
- `@S123` - `@S(\\d+)`
```js
it('@S123 should do something', () => {});
```
- `S123` - `S(\\d+)`
```js
it('S123 should do something', () => {});
```
- `S-123` - `S-(\\d+)`
```js
it('S-123 should do something', () => {});
```
- `S_123` - `S_(\\d+)`
```js
it('S_123 should do something', () => {});
```
- `.S123.` - `.S(\\d+)\\.`
```js
it('.S123. should do something', () => {});
```
- `@S-123` - `@S-(\\d+)`
```js
it('@S-123 should do something', () => {});
```
- `:S123:` - `:S(\\d+):`
```js
it(':S123: should do something', () => {});
```
## Author
Yevhen Laichenkov