chore(contributing.md): markdown list item adjustments (#32859)

This commit is contained in:
Adam Patridge 2024-09-30 01:48:01 -06:00 committed by GitHub
parent 11014145ce
commit 2f7b06736f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -29,32 +29,32 @@ npm i -g npm@latest
1. Clone this repository 1. Clone this repository
```bash ```bash
git clone https://github.com/microsoft/playwright git clone https://github.com/microsoft/playwright
cd playwright cd playwright
``` ```
2. Install dependencies 2. Install dependencies
```bash ```bash
npm ci npm ci
``` ```
3. Build Playwright 3. Build Playwright
```bash ```bash
npm run build npm run build
``` ```
4. Run tests 4. Run tests
This will run a test on line `23` in `page-fill.spec.ts`: This will run a test on line `23` in `page-fill.spec.ts`:
```bash ```bash
npm run ctest -- page-fill:23 npm run ctest -- page-fill:23
``` ```
See [here](#running--writing-tests) for more information about running and writing tests. See [here](#running--writing-tests) for more information about running and writing tests.
### Code reviews ### Code reviews
@ -155,63 +155,65 @@ These are integration tests, making sure public API methods and events work as e
- To run all tests: - To run all tests:
```bash ```bash
npx playwright install npx playwright install
npm run test npm run test
``` ```
Be sure to run `npm run build` or let `npm run watch` run before you re-run the Be sure to run `npm run build` or let `npm run watch` run before you re-run the
tests after making your changes to check them. tests after making your changes to check them.
- To run tests in Chromium - To run tests in Chromium
```bash
npm run ctest # also `ftest` for firefox and `wtest` for WebKit
npm run ctest -- page-fill:23 # runs line 23 of page-fill.spec.ts
```
To run tests in WebKit / Firefox, use `wtest` or `ftest`. ```bash
npm run ctest # also `ftest` for firefox and `wtest` for WebKit
npm run ctest -- page-fill:23 # runs line 23 of page-fill.spec.ts
```
- To run tests in WebKit / Firefox, use `wtest` or `ftest`.
- To run the Playwright test runner tests - To run the Playwright test runner tests
```bash
npm run ttest ```bash
npm run ttest -- --grep "specific test" npm run ttest
``` npm run ttest -- --grep "specific test"
```
- To run a specific test, substitute `it` with `it.only`, or use the `--grep 'My test'` CLI parameter: - To run a specific test, substitute `it` with `it.only`, or use the `--grep 'My test'` CLI parameter:
```js ```js
... ...
// Using "it.only" to run a specific test // Using "it.only" to run a specific test
it.only('should work', async ({server, page}) => { it.only('should work', async ({server, page}) => {
const response = await page.goto(server.EMPTY_PAGE); const response = await page.goto(server.EMPTY_PAGE);
expect(response.ok).toBe(true); expect(response.ok).toBe(true);
}); });
// or // or
playwright test --config=xxx --grep 'should work' playwright test --config=xxx --grep 'should work'
``` ```
- To disable a specific test, substitute `it` with `it.skip`: - To disable a specific test, substitute `it` with `it.skip`:
```js ```js
... ...
// Using "it.skip" to skip a specific test // Using "it.skip" to skip a specific test
it.skip('should work', async ({server, page}) => { it.skip('should work', async ({server, page}) => {
const response = await page.goto(server.EMPTY_PAGE); const response = await page.goto(server.EMPTY_PAGE);
expect(response.ok).toBe(true); expect(response.ok).toBe(true);
}); });
``` ```
- To run tests in non-headless (headed) mode: - To run tests in non-headless (headed) mode:
```bash ```bash
npm run ctest -- --headed npm run ctest -- --headed
``` ```
- To run tests with custom browser executable, specify `CRPATH`, `WKPATH` or `FFPATH` env variable that points to browser executable: - To run tests with custom browser executable, specify `CRPATH`, `WKPATH` or `FFPATH` env variable that points to browser executable:
```bash ```bash
CRPATH=<path-to-executable> npm run ctest CRPATH=<path-to-executable> npm run ctest
``` ```
- When should a test be marked with `skip` or `fixme`? - When should a test be marked with `skip` or `fixme`?