Skip to content

Commit 3cc5d9a

Browse files
author
John Doherty
committed
corrected json formatting in readme and added new entry to TOC
1 parent 3dc1e5a commit 3cc5d9a

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.MD

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ JavaScript browser automation framework using official [selenium-webdriver](http
99
* [Installation](#installation)
1010
* [Usage](#usage)
1111
* [Options](#options)
12+
* [Default configuration file](#default-configuration-file)
1213
* [Feature files](#feature-files)
1314
* [Step definitions](#step-definitions)
1415
* [Page objects](#page-objects)
@@ -62,36 +63,38 @@ By default tests are run using Google Chrome, to run tests using another browser
6263
| Phantom JS | `-b phantomjs`
6364

6465
### Default configuration file
66+
6567
Many configuration options can be defaulted so they don't need to be overridden on the command line.
6668
The JSON keys are the "long name" from the command line options.
67-
69+
6870
A "selenium-cucumber-js.json" file at the root of your project allows you to specify a subset of configuration overrides.
6971

70-
For example the following duplicates default configuration.
72+
For example the following duplicates default configuration:
7173

7274
```json
7375
{
74-
steps: './step-definitions',
75-
pageObjects: './page-objects',
76-
sharedObjects: './shared-objects',
77-
reports: './reports',
78-
browser: 'chrome',
79-
timeout: 10000
76+
"steps": "./step-definitions",
77+
"pageObjects": "./page-objects",
78+
"sharedObjects": "./shared-objects",
79+
"reports": "./reports",
80+
"browser": "chrome",
81+
"timeout": 10000
8082
}
8183
```
84+
8285
This would set configuration to match the expected directory structure of IntelliJ's Cucumber plugin, and make default timeout one minute.
8386
Note that the default browser has not been overridden and will remain 'chrome'.
87+
8488
```json
8589
{
86-
steps: './features/step_definitions',
87-
pageObjects: './features/page_objects',
88-
sharedObjects: './features/shared_objects',
89-
reports: './features/reports',
90-
timeout: 60000
90+
"steps": "./features/step_definitions",
91+
"pageObjects": "./features/page_objects",
92+
"sharedObjects": "./features/shared_objects",
93+
"reports": "./features/reports",
94+
"timeout": 60000
9195
}
9296
```
9397

94-
9598
### Feature files
9699

97100
A feature file is a [Business Readable, Domain Specific Language](http://martinfowler.com/bliki/BusinessReadableDSL.html) file that lets you describe software’s behavior without detailing how that behavior is implemented. Feature files are written using the [Gherkin syntax](https://github.com/cucumber/cucumber/wiki/Gherkin) and must live in a folder named **features** within the root of your project.

0 commit comments

Comments
 (0)