docs: fix typo (#14435)

This commit is contained in:
fetsorn 2025-04-29 19:45:18 +03:00 committed by GitHub
parent 780ae101c0
commit 128e3f7f20
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 8 additions and 8 deletions

View file

@ -84,7 +84,7 @@ If you’re only fixing a bug, it’s fine to submit a pull request right away,
If you make any changes to the code, you want to test it quickly to see if they do what you expect. There are a couple of ways to do that in WebdriverIO. For one, you can link single sub-packages into your own project to see if the changes you've made have the effect you expected.
Another way to test changes in WebdriverIO is by using its [example directory](https://github.com/webdriverio/webdriverio/tree/main/examples) or by running its [smoke test suite](https://github.com/webdriverio/webdriverio/tree/main/tests). The example directory is a set of sample scripts that use WebdriverIO in various of ways. Here, you need to have a browser driver running to run the scripts. With the smoke test suite you can run various flavors of WebdriverIO within a predefined execution scenario. All of these scenarios are defined in our [WebDriver Mock Service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-webdriver-mock-service) that mimics a browser driver by stubbing the endpoints with predefined responses. It is a great way to run WebdriverIO suites quickly without having to setup anything.
Another way to test changes in WebdriverIO is by using its [example directory](https://github.com/webdriverio/webdriverio/tree/main/examples) or by running its [smoke test suite](https://github.com/webdriverio/webdriverio/tree/main/tests). The example directory is a set of sample scripts that use WebdriverIO in various ways. Here, you need to have a browser driver running to run the scripts. With the smoke test suite you can run various flavors of WebdriverIO within a predefined execution scenario. All of these scenarios are defined in our [WebDriver Mock Service](https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-webdriver-mock-service) that mimics a browser driver by stubbing the endpoints with predefined responses. It is a great way to run WebdriverIO suites quickly without having to setup anything.
### Make a Pull Request

View file

@ -27,7 +27,7 @@ We are organising all roadmap items [in GitHub](https://github.com/orgs/webdrive
|[Jest Framework Support](https://github.com/webdriverio/webdriverio/projects/2)|Jest has become one of the most popular unit test framework in the JS ecosystem. Even though most of their features are not helpful in the e2e space there are some things (e.g. snapshot testing) that could help people writing better e2e tests. There has been some initial work done on this.|2019-12-20|[v6.0.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#4908](https://github.com/webdriverio/webdriverio/pull/4908)|
|[Custom Assertion Library](https://github.com/webdriverio/webdriverio/projects/11)|To make assertion on elements or other objects simpler across all frameworks it would be nice if WebdriverIO would come with an native assertion library (similar how Jest or Jasmine provide one) embedded into the testrunner.|2019-12-20|[v6.0.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#4908](https://github.com/webdriverio/webdriverio/pull/4908)|
|[Autogenerate Sample Files](https://github.com/webdriverio/webdriverio/projects/10)|Let's allow user to pre-setup an existing boilerplate so that they don't need to setup these files by themselves. The community has gathered a lot of useful boilerplate projects that we want to allow to act as baseline for the test setup using the configuration wizard or a new `wdio` command.|2020-06-13|[v6.2.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#5590](https://github.com/webdriverio/webdriverio/pull/5590)
|[Integrating WebdriverIO is common use setup build tools](https://github.com/webdriverio/webdriverio/projects/5)|There are various of projects that help you to bootstrap a project from scratch (e.g. [create-react-app](https://github.com/facebook/create-react-app)). We should add WebdriverIO as e2e testing option in there which will help us to driver adoption.|2020-07-18|[v6.2.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#5636](https://github.com/webdriverio/webdriverio/pull/5636)
|[Integrating WebdriverIO is common use setup build tools](https://github.com/webdriverio/webdriverio/projects/5)|There are various projects that help you to bootstrap a project from scratch (e.g. [create-react-app](https://github.com/facebook/create-react-app)). We should add WebdriverIO as e2e testing option in there which will help us to driver adoption.|2020-07-18|[v6.2.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#5636](https://github.com/webdriverio/webdriverio/pull/5636)
|[Network Primitives](https://github.com/webdriverio/webdriverio/projects/13)|As we have better cross browser support for Puppeteer we should move forward and provide better network primitives for WebdriverIO to help user access the network layer. In addition to that these features are likely to be supported once WebDriver moves to a BiDi protocol (which is a new version of WebDriver that is currently designed by the W3C working group and browser vendors).|2020-07-16|[v6.3.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md)|[#5477](https://github.com/webdriverio/webdriverio/pull/5477)
|[TypeScript Rewrite](https://github.com/webdriverio/webdriverio/projects/14)|As our code base is growing we are more impacted by type issues that are hard to detect. To avoid such problems and make the code base easier to work with we plan to rewrite it into TypeScript.|2021-02-08|[v7.0.0](https://github.com/webdriverio/webdriverio/blob/v7/CHANGELOG.md)|[#6302](https://github.com/webdriverio/webdriverio/pull/6302)
|[ESM Support](https://github.com/webdriverio/webdriverio/pull/6812)|With the ecosystem moving towards the ESM module system we transformed the complete code base to run within an ESM environment with compatibility for CommonJS projects.|2022-12-01|[v8.0.0](https://github.com/webdriverio/webdriverio/blob/main/CHANGELOG.md#v800-2022-12-01)|[#6812](https://github.com/webdriverio/webdriverio/pull/6812)

View file

@ -195,7 +195,7 @@ export interface Testrunner extends Hooks, WebdriverIO, WebdriverIO.HookFunction
*/
exclude?: string[]
/**
* An object describing various of suites, which you can then specify
* An object describing various suites, which you can then specify
* with the --suite option on the wdio CLI.
*/
suites?: Record<string, (string |string[])[] | string[][]>

View file

@ -51,7 +51,7 @@ If you are still unsure how everything works, watch the following tutorial on ho
## Test Harness
It is totally up to you what you want to run in your tests and how you like to render the components. However we recommend to use the [Testing Library](https://testing-library.com/) as utility framework as it provides plugins for various of component frameworks, such as React, Preact, Svelte and Vue. It is very useful for rendering components into the test page and it automatically cleans up these components after every test.
It is totally up to you what you want to run in your tests and how you like to render the components. However we recommend to use the [Testing Library](https://testing-library.com/) as utility framework as it provides plugins for various component frameworks, such as React, Preact, Svelte and Vue. It is very useful for rendering components into the test page and it automatically cleans up these components after every test.
You can mix Testing Library primitives with WebdriverIO commands as you wish, e.g.:

View file

@ -319,7 +319,7 @@ Default: `[]`
### suites
An object describing various of suites, which you can then specify with the `--suite` option on the `wdio` CLI.
An object describing various suites, which you can then specify with the `--suite` option on the `wdio` CLI.
Type: `Object`<br />
Default: `{}`

View file

@ -22,7 +22,7 @@ node_modules
```
:::info
We are using a Docker image here that comes with Selenium and Google Chrome pre-installed. There are various of images available with different browser setups and browser versions. Check out the images maintained by the Selenium project [on Docker Hub](https://hub.docker.com/u/selenium).
We are using a Docker image here that comes with Selenium and Google Chrome pre-installed. There are various images available with different browser setups and browser versions. Check out the images maintained by the Selenium project [on Docker Hub](https://hub.docker.com/u/selenium).
:::
As we can only run Google Chrome in headless mode in our Docker container we have to modify our `wdio.conf.js` to ensure we do that:

View file

@ -3,7 +3,7 @@ id: modules
title: Modules
---
WebdriverIO publishes various of modules to NPM and other registries that you can use to build your own automation framework. See more documentation on WebdriverIO setup types [here](/docs/setuptypes).
WebdriverIO publishes various modules to NPM and other registries that you can use to build your own automation framework. See more documentation on WebdriverIO setup types [here](/docs/setuptypes).
## `webdriver` and `devtools`

View file

@ -3,7 +3,7 @@ id: protocols
title: Protocol Commands
---
WebdriverIO is an automation framework that relies on various of automation protocols to control a remote agent, e.g. for a browser, mobile device or television. Based on the remote device different protocols come into play. These commands are assigned to the [Browser](/docs/api/browser) or [Element](/docs/api/element) Object depending on the session information by the remote server (e.g. browser driver).
WebdriverIO is an automation framework that relies on various automation protocols to control a remote agent, e.g. for a browser, mobile device or television. Based on the remote device different protocols come into play. These commands are assigned to the [Browser](/docs/api/browser) or [Element](/docs/api/element) Object depending on the session information by the remote server (e.g. browser driver).
Internally WebdriverIO uses protocol commands for almost all interactions with the remote agent. However additional commands assigned to the [Browser](/docs/api/browser) or [Element](/docs/api/element) Object simplify the usage of WebdriverIO, e.g. getting the text of an element using protocol commands would look like this: