You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/basics.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -296,7 +296,7 @@ Tests are written in a synchronous way. This improves the readability and mainta
296
296
While writing tests you should not think about promises, and instead should focus on the test scenario.
297
297
298
298
However, behind the scenes **all actions are wrapped in promises**, inside of the `I` object.
299
-
[Global promise](https://github.com/codecept-js/CodeceptJS/blob/master/lib/recorder.js) chain is initialized before each test and all `I.*` calls will be appended to it, as well as setup and teardown.
299
+
[Global promise](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/recorder.js) chain is initialized before each test and all `I.*` calls will be appended to it, as well as setup and teardown.
300
300
301
301
> 📺 [Learn how CodeceptJS](https://www.youtube.com/watch?v=MDLLpHAwy_s) works with promises by watching video on YouTube
302
302
@@ -402,7 +402,7 @@ You can have multiple configuration files for a the same project, in this case y
402
402
npx codeceptjs run -c codecept.ci.conf.js
403
403
```
404
404
405
-
Tuning configuration for helpers like WebDriver, Puppeteer can be hard, as it requires good understanding of how these technologies work. Use the [`@codeceptjs/configure`](https://github.com/codecept-js/configure) package with common configuration recipes.
405
+
Tuning configuration for helpers like WebDriver, Puppeteer can be hard, as it requires good understanding of how these technologies work. Use the [`@codeceptjs/configure`](https://github.com/codeceptjs/configure) package with common configuration recipes.
406
406
407
407
For instance, you can set the window size or toggle headless mode, no matter of which helpers are actually used.
408
408
@@ -419,7 +419,7 @@ exports.config = {
419
419
}
420
420
```
421
421
422
-
> ▶ See more [configuration recipes](https://github.com/codecept-js/configure)
422
+
> ▶ See more [configuration recipes](https://github.com/codeceptjs/configure)
423
423
424
424
## Debug
425
425
@@ -616,7 +616,7 @@ AfterSuite((I) => {
616
616
});
617
617
```
618
618
619
-
[Here are some ideas](https://github.com/codecept-js/CodeceptJS/pull/231#issuecomment-249554933) on where to use BeforeSuite hooks.
619
+
[Here are some ideas](https://github.com/codeceptjs/CodeceptJS/pull/231#issuecomment-249554933) on where to use BeforeSuite hooks.
Copy file name to clipboardExpand all lines: docs/configuration.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -101,7 +101,7 @@ codeceptjs run --config=./path/to/my/config.js
101
101
102
102
> 📺 [Watch this material](https://www.youtube.com/watch?v=onBnfo_rJa4&t=4s) on YouTube
103
103
104
-
[`@codeceptjs/configure` package](https://github.com/codecept-js/configure) contains shared recipes for common configuration patterns. This allows to set meta-configuration, independent from a current helper enabled.
104
+
[`@codeceptjs/configure` package](https://github.com/codeceptjs/configure) contains shared recipes for common configuration patterns. This allows to set meta-configuration, independent from a current helper enabled.
105
105
106
106
Install it and enable to easily switch to headless/window mode, change window size, etc.
Copy file name to clipboardExpand all lines: docs/hooks.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -240,7 +240,7 @@ module.exports = {
240
240
241
241
Plugins allow to use CodeceptJS internal API to extend functionality. Use internal event dispatcher, container, output, promise recorder, to create your own reporters, test listeners, etc.
242
242
243
-
CodeceptJS includes [built-in plugins](/plugins/) which extend basic functionality and can be turned on and off on purpose. Taking them as [examples](https://github.com/codecept-js/CodeceptJS/tree/master/lib/plugin) you can develop your custom plugins.
243
+
CodeceptJS includes [built-in plugins](/plugins/) which extend basic functionality and can be turned on and off on purpose. Taking them as [examples](https://github.com/codeceptjs/CodeceptJS/tree/master/lib/plugin) you can develop your custom plugins.
244
244
245
245
A plugin is a basic JS module returning a function. Plugins can have individual configs which are passed into this function:
Plugin can register event listeners or hook into promise chain with recorder. See [API reference](https://github.com/codecept-js/CodeceptJS/tree/master/lib/helper).
258
+
Plugin can register event listeners or hook into promise chain with recorder. See [API reference](https://github.com/codeceptjs/CodeceptJS/tree/master/lib/helper).
259
259
260
260
To enable your custom plugin in config add it to `plugins` section. Specify path to node module using `require`.
*[`container`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/container.js): dependency injection container for tests, includes current helpers and support objects
341
-
*[`helper`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/helper.js): basic helper class
342
-
*[`actor`](https://github.com/codecept-js/CodeceptJS/blob/master/lib/actor.js): basic actor (I) class
335
+
*[`codecept`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/codecept.js): test runner class
336
+
*[`config`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/config.js): current codecept config
*[`container`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/container.js): dependency injection container for tests, includes current helpers and support objects
341
+
*[`helper`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/helper.js): basic helper class
342
+
*[`actor`](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/actor.js): basic actor (I) class
343
343
344
-
[API reference](https://github.com/codecept-js/CodeceptJS/tree/master/docs/api) is available on GitHub.
344
+
[API reference](https://github.com/codeceptjs/CodeceptJS/tree/master/docs/api) is available on GitHub.
345
345
Also please check the source code of corresponding modules.
346
346
347
347
### Event Listeners
348
348
349
-
CodeceptJS provides a module with [event dispatcher and set of predefined events](https://github.com/codecept-js/CodeceptJS/blob/master/lib/event.js).
349
+
CodeceptJS provides a module with [event dispatcher and set of predefined events](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/event.js).
350
350
351
351
It can be required from codeceptjs package if it is installed locally.
352
352
@@ -387,7 +387,7 @@ Available events:
387
387
**sync* - means that event is fired in the moment of action happens.
388
388
**async* - means that event is fired when an actions is scheduled. Use `recorder` to schedule your actions.
389
389
390
-
For further reference look for [currently available listeners](https://github.com/codecept-js/CodeceptJS/tree/master/lib/listener) using event system.
390
+
For further reference look for [currently available listeners](https://github.com/codeceptjs/CodeceptJS/tree/master/lib/listener) using event system.
391
391
392
392
#### Test Object
393
393
@@ -419,7 +419,7 @@ Step events provide step objects with following fields:
419
419
420
420
### Recorder
421
421
422
-
To inject asynchronous functions in a test or before/after a test you can subscribe to corresponding event and register a function inside a recorder object. [Recorder](https://github.com/codecept-js/CodeceptJS/blob/master/lib/recorder.js) represents a global promises chain.
422
+
To inject asynchronous functions in a test or before/after a test you can subscribe to corresponding event and register a function inside a recorder object. [Recorder](https://github.com/codeceptjs/CodeceptJS/blob/master/lib/recorder.js) represents a global promises chain.
423
423
424
424
Provide a function description as a first parameter, function should return a promise:
0 commit comments