Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/microsoft/playwright-vscode
Playwright Test Visual Studio Code integration
https://github.com/microsoft/playwright-vscode
playwright testing typescript vscode vscode-extension
Last synced: about 2 hours ago
JSON representation
Playwright Test Visual Studio Code integration
- Host: GitHub
- URL: https://github.com/microsoft/playwright-vscode
- Owner: microsoft
- License: apache-2.0
- Created: 2021-06-24T18:43:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T18:33:07.000Z (10 days ago)
- Last Synced: 2024-12-20T14:12:16.649Z (8 days ago)
- Topics: playwright, testing, typescript, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=ms-playwright.playwright
- Size: 2.17 MB
- Stars: 351
- Watchers: 15
- Forks: 74
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Support: SUPPORT.md
Awesome Lists containing this project
README
# Playwright Test for VS Code
This extension integrates Playwright into your VS Code workflow. Here is what it can do:
- [Playwright Test for VS Code](#playwright-test-for-vs-code)
- [Requirements](#requirements)
- [Install Playwright](#install-playwright)
- [Run tests with a single click](#run-tests-with-a-single-click)
- [Run multiple tests](#run-multiple-tests)
- [Run tests in watch mode](#run-tests-in-watch-mode)
- [Show browsers](#show-browsers)
- [Show trace viewer](#show-trace-viewer)
- [Pick locators](#pick-locators)
- [Debug step-by-step, explore locators](#debug-step-by-step-explore-locators)
- [Tune locators](#tune-locators)
- [Record new tests](#record-new-tests)
- [Record at cursor](#record-at-cursor)
### Requirements
This extension works with [Playwright] version v1.38+ or newer.
## Install Playwright
If you don't have the Playwright NPM package installed in your project, or if you are starting with a new testing project, the "Install Playwright" action from the command panel will help you get started.
Pick the browsers you'd like to use by default, don't worry, you'll be able to change them later to add or configure the browsers used. You can also choose to add a GitHub Action so that you can easily run tests on Continuous Integration on every pull request or push.
The extension automatically detects if you have [Playwright] installed and loads the browsers, known as [Playwright] projects, into Visual Studio Code. By default it will select the first project as a run profile. Inside the test explorer in VS Code you can change this behavior to run a single test in multiple or different browsers.
## Run tests with a single click
Click the green triangle next to the test you want to run. You can also run the test from the testing sidebar by clicking the grey triangle next to the test name.
## Run multiple tests
You can use the Testing sidebar to run a single test or a group of tests with a single click. While tests are running, the execution line is highlighted. Once the line has completed, the duration of each step of the test is shown.
## Run tests in watch mode
Click the "eye" icon to run tests in watch mode. This will re-run the watched tests when you save your changes.
## Show browsers
Check the "show browsers" checkbox to run tests with the browser open so that you can visually see what is happening while your test is running. Click on "close all browsers" to close the browsers.
## Show trace viewer
Check the "show trace viewer" checkbox to see a full trace of your test.
## Pick locators
Click the "pick locator" button and hover over the browser to see the locators available. Clicking an element will store it in the locators box in VS Code. Pressing enter will save it to the clip board so you can easily paste it into your code or press the escape key to cancel.
## Debug step-by-step, explore locators
Right click and start breakpoint debugging. Set a breakpoint and hover over a value. When your cursor is on some Playwright action or a locator, the corresponding element (or elements) are highlighted in the browser.
## Tune locators
You can edit the source code to fine-tune locators while on a breakpoint. Test out different locators and see them highlighted in the browser.
## Record new tests
Record new tests by clicking on the "record tests" button in the testing sidebar. This will open a browser window where you can navigate to a URL and perform actions on the page which will be recorded to a new test file in VS Code.
## Record at cursor
This generates actions into the existing test at the current cursor position. You can run the test, position the cursor at the end of the test and continue generating the test.
[Playwright]: https://playwright.dev "Playwright"