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/configuration.md
+19-19Lines changed: 19 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -9,26 +9,26 @@ CodeceptJS configuration is set in `codecept.conf.js` file.
9
9
10
10
After running `codeceptjs init` it should be saved in test root.
11
11
12
-
| Name | Type | Description |
13
-
| :------ | :------ |:------|
14
-
|`bootstrap?`| (() => `Promise`<`void`\>) \|`boolean`\|`string`|[Execute code before](https://codecept.io/bootstrap/) tests are run. Can be either JS module file or async function: ```bootstrap: async () => server.launch(), ``` or ```bootstrap: 'bootstrap.js', ```|
15
-
|`bootstrapAll?`| (() => `Promise`<`void`\>) \|`boolean`\|`string`|[Execute code before launching tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)|
|`gherkin.features`|`string`\|`string`[]| load feature files by pattern. Multiple patterns can be specified as array |
18
-
|`gherkin.steps`|`string`[]| load step definitions from JS files |
19
-
|`grep?`|`string`| Pattern to filter tests by name. This option is useful if you plan to use multiple configs for different environments. To execute only tests with @firefox tag use ```grep: '@firefox' ```|
|`include?`|`any`| Include page objects to access them via dependency injection ```I: "./custom_steps.js", loginPage: "./pages/Login.js", User: "./pages/User.js", ``` Configured modules can be injected by name in a Scenario: ```Scenario('test', { I, loginPage, User }) ```|
|`bootstrap?`| (() => `Promise`<`void`\>) \|`boolean`\|`string`|[Execute code before](https://codecept.io/bootstrap/) tests are run. Can be either JS module file or async function: ```bootstrap: async () => server.launch(), ``` or ```bootstrap: 'bootstrap.js', ```|
15
+
|`bootstrapAll?`| (() => `Promise`<`void`\>) \|`boolean`\|`string`|[Execute code before launching tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)|
|`gherkin.features`|`string`\|`string`[]| load feature files by pattern. Multiple patterns can be specified as array |
18
+
|`gherkin.steps`|`string`[]| load step definitions from JS files |
19
+
|`grep?`|`string`| Pattern to filter tests by name. This option is useful if you plan to use multiple configs for different environments. To execute only tests with @firefox tag use ```grep: '@firefox' ```|
|`include?`|`any`| Include page objects to access them via dependency injection ```I: "./custom_steps.js", loginPage: "./pages/Login.js", User: "./pages/User.js", ``` Configured modules can be injected by name in a Scenario: ```Scenario('test', { I, loginPage, User }) ```|
22
22
|`mocha?`|`any`|[Mocha test runner options](https://mochajs.org/#configuring-mocha-nodejs), additional [reporters](https://codecept.io/reports/#xml) can be configured here. Example: ```mocha: { "mocha-junit-reporter": { stdout: "./output/console.log", options: { mochaFile: "./output/result.xml", attachments: true //add screenshot for a failed test } } } ```|
23
-
|`noGlobals?`|`boolean`| Disable registering global functions (Before, Scenario, etc). Not recommended |
24
-
|`output`|`string`| Where to store failure screenshots, artifacts, etc ```output: './output.js' ```|
|`teardown?`| (() => `Promise`<`void`\>) \|`boolean`\|`string`|[Execute code after tests](https://codecept.io/bootstrap/) finished. Can be either JS module file or async function: ```teardown: async () => server.stop(), ``` or ```teardown: 'teardown.js', ```|
28
-
|`teardownAll?`| (() => `Promise`<`void`\>) \|`boolean`\|`string`|[Execute JS code after finishing tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)|
29
-
|`tests`|`string`| Pattern to locate CodeceptJS tests. Allows to enter glob pattern or an Array<string> of patterns to match tests / test file names. For tests in JavaScript: ```tests: 'tests/**.test.js' ``` For tests in TypeScript: ```tests: 'tests/**.test.ts' ```|
30
-
|`timeout?`|`number`| Set default tests timeout in seconds. Tests will be killed on no response after timeout. ```timeout: 20, ```|
31
-
|`translation?`|`string`| Enable [localized test commands](https://codecept.io/translation/)|
23
+
|`noGlobals?`|`boolean`| Disable registering global functions (Before, Scenario, etc). Not recommended |
24
+
|`output`|`string`| Where to store failure screenshots, artifacts, etc ```output: './output' ```|
|`teardown?`| (() => `Promise`<`void`\>) \|`boolean`\|`string`|[Execute code after tests](https://codecept.io/bootstrap/) finished. Can be either JS module file or async function: ```teardown: async () => server.stop(), ``` or ```teardown: 'teardown.js', ```|
28
+
|`teardownAll?`| (() => `Promise`<`void`\>) \|`boolean`\|`string`|[Execute JS code after finishing tests in parallel mode](https://codecept.io/bootstrap/#bootstrapall-teardownall)|
29
+
|`tests`|`string`| Pattern to locate CodeceptJS tests. Allows to enter glob pattern or an Array<string> of patterns to match tests / test file names. For tests in JavaScript: ```tests: 'tests/**.test.js' ``` For tests in TypeScript: ```tests: 'tests/**.test.ts' ```|
30
+
|`timeout?`|`number`| Set default tests timeout in seconds. Tests will be killed on no response after timeout. ```timeout: 20, ```|
31
+
|`translation?`|`string`| Enable [localized test commands](https://codecept.io/translation/)|
0 commit comments