Skip to content

Commit

Permalink
Address review feedback
Browse files Browse the repository at this point in the history
  * Apply README template to @theia/playwright readme
  * Remove target from tslint config to fall back to Theia's default
  * Minor improvements in developer documentation
  • Loading branch information
planger committed Feb 2, 2022
1 parent 91fa479 commit 094f5c8
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 8 deletions.
37 changes: 31 additions & 6 deletions examples/playwright/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,16 @@
# Theia 🎭 Playwright: A System Testing Framework for Theia
<div align='center'>

<br />

<img src='https://raw.githubusercontent.com/eclipse-theia/theia/master/logo/theia.svg?sanitize=true' alt='theia-ext-logo' width='100px' />

<h2>ECLIPSE THEIA - PLAYWRIGHT</h2>

<hr />

</div>

## Description

Theia 🎭 Playwright is a [page object](https://martinfowler.com/bliki/PageObject.html) framework based on [Playwright](https://github.com/microsoft/playwright) for developing system tests of [Theia](https://github.com/eclipse-theia/theia)-based applications. See it in action below.

Expand All @@ -19,10 +31,23 @@ It is [extensible](./docs/EXTENSIBILITY.md) so you can add dedicated page object

## Documentation

- [Getting Started](./docs/GETTING_STARTED.md)
- [Extensibility](./docs/EXTENSIBILITY.md)
- [Building and Developing Theia 🎭 Playwright](./docs/DEVELOPING.md)
- [Getting Started](./docs/GETTING_STARTED.md)
- [Extensibility](./docs/EXTENSIBILITY.md)
- [Building and Developing Theia 🎭 Playwright](./docs/DEVELOPING.md)

## Additional Information

- [Theia - GitHub](https://github.com/eclipse-theia/theia)
- [Theia - Website](https://theia-ide.org/)
- [Playwright - GitHub](https://github.com/microsoft/playwright)
- [Playwright - Website](https://playwright.dev)

## License

- [Eclipse Public License 2.0](http://www.eclipse.org/legal/epl-2.0/)
- [一 (Secondary) GNU General Public License, version 2 with the GNU Classpath Exception](https://projects.eclipse.org/license/secondary-gpl-2.0-cp)

## Get in touch
## Trademark

If you have problems, find bugs or have questions, feel free to get in contact via the bugs and discussions.
"Theia" is a trademark of the Eclipse Foundation
https://www.eclipse.org/theia
2 changes: 1 addition & 1 deletion examples/playwright/docs/DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ You may also use the `Launch Browser Backend` launch configuration in VS Code.

### Running the tests headless

To start the tests run `yarn ui-tests` in the root of this repository. This will start the tests located in `tests` in a headless mode.
To start the tests run `yarn ui-tests` in the root of this package. This will start the tests located in `tests` in a headless mode.

To only run a single test file, the path of a test file can be set with `yarn ui-tests <path-to-file>` or `yarn ui-tests -g "<partial test file name>"`.
See the [Playwright Test command line documentation](https://playwright.dev/docs/intro#command-line).
Expand Down
1 change: 0 additions & 1 deletion examples/playwright/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"extends": "../../configs/base.tsconfig",
"compilerOptions": {
"composite": true,
"target": "ES2018",
"lib": [
"dom",
"dom.iterable",
Expand Down

0 comments on commit 094f5c8

Please sign in to comment.