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: src/content/docs/plugins.md
+36-36Lines changed: 36 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,79 +4,79 @@ title: Plugins
4
4
<!-- Auto-generated by scripts/sync-codeceptjs-docs.mjs from codeceptjs/CodeceptJS@4.x. Do not edit. -->
5
5
CodeceptJS bundles the following plugins. Each plugin has its own page with full configuration reference.
6
6
7
-
## [pause](/plugins/pause)
7
+
## [aiTrace](/plugins/aiTrace)
8
8
9
-
Pauses test execution interactively. Replaces the legacy `pauseOnFail` plugin. The default `on=fail` matches the old `pauseOnFail` behavior.
9
+
Generates AI-friendly trace files for debugging with AI agents. This plugin creates a markdown file with test execution logs and links to all artifacts (screenshots, HTML, ARIA snapshots, browser logs, HTTP requests) for each step.
10
10
11
-
## [pageInfo](/plugins/pageInfo)
11
+
## [analyze](/plugins/analyze)
12
12
13
-
Collects information from web page after each failed test and adds it to the test as an artifact. It is suggested to enable this plugin if you run tests on CI and you need to debug failed tests. This plugin can be paired with `analyze` plugin to provide more context.
13
+
Uses AI to analyze test failures and provide insights
14
14
15
-
## [expose](/plugins/expose)
15
+
## [auth](/plugins/auth)
16
16
17
-
Exposes properties from helper instances as injectable test arguments. Use it to access the underlying Playwright/Puppeteer `page`, the wdio `browser` client, or any other helper internal directly from a Scenario:
17
+
Logs user in for the first test and reuses session for next tests. Works by saving cookies into memory or file. If a session expires automatically logs in again.
18
18
19
-
## [junitReporter](/plugins/junitReporter)
19
+
## [autoDelay](/plugins/autoDelay)
20
20
21
-
Generates a JUnit-compatible XML report after a test run.
21
+
Sometimes it takes some time for a page to respond to user's actions. Depending on app's performance this can be either slow or fast.
22
+
23
+
## [browser](/plugins/browser)
24
+
25
+
Overrides browser helper config from the command line. Works for all browser helpers (Playwright, Puppeteer, WebDriver, Appium) without touching `codecept.conf`.
22
26
23
27
## [coverage](/plugins/coverage)
24
28
25
29
Dumps code coverage from Playwright/Puppeteer after every test.
26
30
27
-
## [screenshot](/plugins/screenshot)
31
+
## [customLocator](/plugins/customLocator)
28
32
29
-
Saves screenshots from the browser at points triggered by `on=`.
33
+
Creates a [custom locator][1] by using special attributes in HTML.
30
34
31
-
## [screencast](/plugins/screencast)
35
+
## [customReporter](/plugins/customReporter)
32
36
33
-
Records WebM video of tests using Playwright's screencast API.
37
+
Sample custom reporter for CodeceptJS.
34
38
35
-
## [customLocator](/plugins/customLocator)
39
+
## [expose](/plugins/expose)
36
40
37
-
Creates a [custom locator][1] by using special attributes in HTML.
41
+
Exposes properties from helper instances as injectable test arguments. Use it to access the underlying Playwright/Puppeteer `page`, the wdio `browser` client, or any other helper internal directly from a Scenario:
38
42
39
-
## [aiTrace](/plugins/aiTrace)
43
+
## [heal](/plugins/heal)
40
44
41
-
Generates AI-friendly trace files for debugging with AI agents. This plugin creates a markdown file with test execution logs and links to all artifacts (screenshots, HTML, ARIA snapshots, browser logs, HTTP requests) for each step.
45
+
Self-healing tests with AI.
42
46
43
-
## [auth](/plugins/auth)
47
+
## [junitReporter](/plugins/junitReporter)
44
48
45
-
Logs user in for the first test and reuses session for next tests. Works by saving cookies into memory or file. If a session expires automatically logs in again.
49
+
Generates a JUnit-compatible XML report after a test run.
46
50
47
-
## [pauseOnFail](/plugins/pauseOnFail)
51
+
## [pageInfo](/plugins/pageInfo)
48
52
49
-
Starts an interactive pause when a test fails.
53
+
Collects information from web page after each failed test and adds it to the test as an artifact. It is suggested to enable this plugin if you run tests on CI and you need to debug failed tests. This plugin can be paired with `analyze` plugin to provide more context.
50
54
51
-
## [analyze](/plugins/analyze)
55
+
## [pause](/plugins/pause)
52
56
53
-
Uses AI to analyze test failures and provide insights
57
+
Pauses test execution interactively. Replaces the legacy `pauseOnFail` plugin. The default `on=fail` matches the old `pauseOnFail` behavior.
54
58
55
-
## [autoDelay](/plugins/autoDelay)
59
+
## [pauseOnFail](/plugins/pauseOnFail)
56
60
57
-
Sometimes it takes some time for a page to respond to user's actions. Depending on app's performance this can be either slow or fast.
61
+
Starts an interactive pause when a test fails.
58
62
59
-
## [stepTimeout](/plugins/stepTimeout)
63
+
## [retryFailedStep](/plugins/retryFailedStep)
60
64
61
-
Set timeout for test steps globally.
65
+
Retries each failed step in a test.
62
66
63
-
## [heal](/plugins/heal)
67
+
## [screencast](/plugins/screencast)
64
68
65
-
Self-healing tests with AI.
69
+
Records WebM video of tests using Playwright's screencast API.
66
70
67
-
## [customReporter](/plugins/customReporter)
71
+
## [screenshot](/plugins/screenshot)
68
72
69
-
Sample custom reporter for CodeceptJS.
73
+
Saves screenshots from the browser at points triggered by `on=`.
70
74
71
75
## [screenshotOnFail](/plugins/screenshotOnFail)
72
76
73
77
Saves a screenshot when a test fails.
74
78
75
-
## [retryFailedStep](/plugins/retryFailedStep)
76
-
77
-
Retries each failed step in a test.
78
-
79
-
## [browser](/plugins/browser)
79
+
## [stepTimeout](/plugins/stepTimeout)
80
80
81
-
Overrides browser helper config from the command line. Works for all browser helpers (Playwright, Puppeteer, WebDriver, Appium) without touching `codecept.conf`.
0 commit comments