diff --git a/docs/src/getting-started-vscode-js.md b/docs/src/getting-started-vscode-js.md index 4a17863c6d..3f028891ec 100644 --- a/docs/src/getting-started-vscode-js.md +++ b/docs/src/getting-started-vscode-js.md @@ -5,7 +5,7 @@ title: "Getting started - VS Code" Playwright Test was created specifically to accommodate the needs of end-to-end testing. Playwright supports all modern rendering engines including Chromium, WebKit, and Firefox. Test on Windows, Linux, and macOS, locally or on CI, headless or headed with native mobile emulation of Google Chrome for Android and Mobile Safari. -Get started by installing Playwright and generating a test to see it in action. +Get started by installing Playwright and generating a test to see it in action. Alternatively you can also get started and run your tests using the [CLI](./intro.md). ## Installation @@ -13,19 +13,30 @@ Install the [VS Code extension from the marketplace](https://marketplace.visuals image -Once installed, open the command panel and type "Install Playwright" and select "Test: Install Playwright". Choose the browsers you would like to run your tests on. These can be later configured in the [playwright.config file](./test-configuration.md) file. +Once installed, open the command panel and type: +```bash +Install Playwright +``` image +Select "Test: Install Playwright" and Choose the browsers you would like to run your tests on. These can be later configured in the [playwright.config file](./test-configuration.md) file. You can also choose if you would like to have a GitHub Actions setup to run your tests on CI. ## Generating Tests with Codegen -[CodeGen](./codegen.md) will auto generate your tests for you and is a great way to quickly get started. Click on the Testing icon in the left menu to open the testing sidebar. To record a test click on the record icon. This will create a `test-1.spec.ts` file as well as open up a browser window. As you record your user actions your test code will be generated in the newly created file. +[CodeGen](./codegen.md) will auto generate your tests for you and is a great way to quickly get started. Click on the Testing icon in the left menu to open the testing sidebar. + +### Recording a Test + +To record a test click on the record icon. This will create a `test-1.spec.ts` file as well as open up a browser window. image -As you hover over an element Playwright will highlight the element with the [selector](./selectors.md) shown underneath it. If you click the element [CodeGen](./codegen.md) will generate the test for you in the test file that was created. +### Generating a Test + +As you interact with the page Codegen will generate the test for you in the newly created file in VS Code. When you hover over an element Playwright will highlight the element and show the [selector](./selectors.md) underneath it. + image @@ -35,14 +46,20 @@ You can run a single test by clicking the green triangle next to your test block image +### View All Tests + View all tests in the testing sidebar and extend the tests by clicking on each test. Tests that have not been run will not have the green check next to them. image +### Run All Tests + Run all tests by clicking on the white triangle as you hover over the tests in the testing sidebar. image +### Run Tests on Specific Browsers + The VS Code test runner runs your tests on the default browser of Chrome. To run on other/multiple browsers click the play button's dropdown and choose the option of "Select Default Profile" and select the browsers you wish to run your tests on. image @@ -53,7 +70,14 @@ With the VS Code extension you can debug your tests right in VS Code see error m image -Modify your test right in VS Code while debugging and Playwright will highlight the selector you are modifying in the browser. You can step through the tests, pause the test and rerun the tests from the menu in VS Code. +### Live Debugging with VS Code + +Modify your test right in VS Code while debugging and Playwright Test will highlight the selector you are modifying in the browser. You can step through the tests, pause the test and rerun the tests from the menu in VS Code. + image +## What's next + +- [Write tests using web first assertions, page fixtures and locators](./writing-tests.md) +- [See a trace of your tests](./trace-viewer.md) \ No newline at end of file diff --git a/docs/src/intro-js.md b/docs/src/intro-js.md index 010982398f..107927295f 100644 --- a/docs/src/intro-js.md +++ b/docs/src/intro-js.md @@ -5,7 +5,7 @@ title: "Installation" Playwright Test was created specifically to accommodate the needs of end-to-end testing. Playwright supports all modern rendering engines including Chromium, WebKit, and Firefox. Test on Windows, Linux, and macOS, locally or on CI, headless or headed with native mobile emulation of Google Chrome for Android and Mobile Safari. -Get started by installing Playwright and running the example test to see it in action. +Get started by installing Playwright and running the example test to see it in action. Alternatively you can also get started and run your tests using the [VS Code Extension](./getting-started-vscode.md).