Add playwright to js-environments #624
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sjrd
reviewed
Jan 20, 2024
doc/project/js-environments.md
Outdated
| @@ -69,6 +69,51 @@ jsEnv := PhantomJSEnv(args = Seq("arg1", "arg2")).value | |||
| For more options of the PhantomJS environment, see | |||
| [the Scaladoc of `PhantomJSEnv`]({{ site.production_url }}/api/sbt-scalajs-env-phantomjs/1.0.0/org/scalajs/jsenv/phantomjs/sbtplugin/PhantomJSEnvPlugin$$autoImport$.html). | |||
|
|
|||
| ## Playwright | |||
| [Playwright](https://playwright.dev/) is a comprehensive testing library, enabling automation of Chromium, Firefox, and WebKit browsers. It supports multiple platforms and languages, including Mobile Web, making it an optimal choice for testing JavaScript in real browser environments. | |||
There was a problem hiding this comment.
We keep one sentence per line for easier diffs later on:
Suggested change
| [Playwright](https://playwright.dev/) is a comprehensive testing library, enabling automation of Chromium, Firefox, and WebKit browsers. It supports multiple platforms and languages, including Mobile Web, making it an optimal choice for testing JavaScript in real browser environments. | |
| [Playwright](https://playwright.dev/) is a comprehensive testing library, enabling automation of Chromium, Firefox, and WebKit browsers. | |
| It supports multiple platforms and languages, including Mobile Web, making it an optimal choice for testing JavaScript in real browser environments. |
doc/project/js-environments.md
Outdated
| ## Playwright | ||
| [Playwright](https://playwright.dev/) is a comprehensive testing library, enabling automation of Chromium, Firefox, and WebKit browsers. It supports multiple platforms and languages, including Mobile Web, making it an optimal choice for testing JavaScript in real browser environments. | ||
|
|
||
| [`scala-js-env-playwright`](https://github.com/gmkumar2005/scala-js-env-playwright) is an independent project that offers jsEnv and employs Playwright for JavaScript execution. |
There was a problem hiding this comment.
Suggested change
| [`scala-js-env-playwright`](https://github.com/gmkumar2005/scala-js-env-playwright) is an independent project that offers jsEnv and employs Playwright for JavaScript execution. | |
| [`scala-js-env-playwright`](https://github.com/gmkumar2005/scala-js-env-playwright) is an independent project that offers a `JSEnv` that uses Playwright for JavaScript execution. |
doc/project/js-environments.md
Outdated
Comment on lines
79
to
83
| jsEnv := new PWEnv( | ||
| browserName = "chrome", | ||
| headless = true, | ||
| showLogs = true | ||
| ) |
There was a problem hiding this comment.
Suggested change
| jsEnv := new PWEnv( | |
| browserName = "chrome", | |
| headless = true, | |
| showLogs = true | |
| ) | |
| jsEnv := new PWEnv( | |
| browserName = "chrome", | |
| headless = true, | |
| showLogs = true | |
| ) |
doc/project/js-environments.md
Outdated
|
|
||
| [`scala-js-env-playwright`](https://github.com/gmkumar2005/scala-js-env-playwright) is an independent project that offers jsEnv and employs Playwright for JavaScript execution. | ||
|
|
||
| The playwright based `jsEnv` can be enabled by adding following settings in build.sbt |
There was a problem hiding this comment.
Suggested change
| The playwright based `jsEnv` can be enabled by adding following settings in build.sbt | |
| The playwright-based `jsEnv` can be enabled by adding the following settings in `build.sbt` |
doc/project/js-environments.md
Outdated
| showLogs = true | ||
| ) | ||
| ``` | ||
| Addtionally it requires following line in `project/plugins.sbt`: |
There was a problem hiding this comment.
Suggested change
| Addtionally it requires following line in `project/plugins.sbt`: | |
| Addtionally it requires the following line in `project/plugins.sbt`: |
doc/project/js-environments.md
Outdated
| libraryDependencies += "io.github.gmkumar2005" %% "scala-js-env-playwright" % "0.1.8" | ||
| ``` | ||
|
|
||
| The `browserName` parameter accepts `chrome` , `chromium` , `firefox`, and `webkit` as possible options. Please be aware that webkit support is currently in an experimental stage. |
There was a problem hiding this comment.
Suggested change
| The `browserName` parameter accepts `chrome` , `chromium` , `firefox`, and `webkit` as possible options. Please be aware that webkit support is currently in an experimental stage. | |
| The `browserName` parameter accepts `chrome` , `chromium` , `firefox`, and `webkit` as possible options. | |
| Please be aware that webkit support is currently in an experimental stage. |
doc/project/js-environments.md
Outdated
| The `browserName` parameter accepts `chrome` , `chromium` , `firefox`, and `webkit` as possible options. Please be aware that webkit support is currently in an experimental stage. | ||
|
|
||
| ### In browser debugging | ||
| To maintain the browser window open post-execution, simply incorporate the `withKeepAlive` option into the environment. |
There was a problem hiding this comment.
"simply" never adds real meaning to a sentence; it should be removed:
Suggested change
| To maintain the browser window open post-execution, simply incorporate the `withKeepAlive` option into the environment. | |
| To maintain the browser window open post-execution, add the `withKeepAlive` option into the environment. |
doc/project/js-environments.md
Outdated
|
|
||
| ``` | ||
| ### Headless Usage | ||
| Running in headless mode is crucial for operations within Docker containers and build servers. By default, `scala-js-env-playwright` operates in headless mode. However, for debugging purposes, you can set headless to `false`. |
There was a problem hiding this comment.
Suggested change
| Running in headless mode is crucial for operations within Docker containers and build servers. By default, `scala-js-env-playwright` operates in headless mode. However, for debugging purposes, you can set headless to `false`. | |
| Running in headless mode is crucial for operations within Docker containers and build servers. | |
| By default, `scala-js-env-playwright` operates in headless mode. | |
| However, for debugging purposes, you can set headless to `false`. |
|
All recommendations done |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding details of Playwright based js environment.