Skip to content

Commit

Permalink
Update docs around .js config name
Browse files Browse the repository at this point in the history
update .js config filename to match the default .json filename for consistency
  • Loading branch information
garris authored May 1, 2024
1 parent 6d0e5fe commit f8e2ea3
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,13 +114,13 @@ Pass a `--config=<configFilePathStr>` argument to test using a different config

You may use a javascript based config file to allow comments in your config. Be sure to _export your config object as a node module_.

Example: Create a backstop.config.js
Example: Create a backstop.js

```
module.exports = { Same object as backstop.json }
```

and then `backstop test --config="backstop.config.js"`
and then `backstop test --config="backstop.js"`

#### Required Config Properties

Expand Down Expand Up @@ -913,13 +913,13 @@ backstop('test', {
```js
backstop('test', {
config: require("./backstop.config.js")({
config: require("./backstop.js")({
"foo": "bar"
})
});
// Inside of `backstop.config.js` we export a function that returns the configuration object
// Inside of `backstop.js` we export a function that returns the configuration object
module.exports = options => {
return {
//you can access options.foo here
Expand Down

0 comments on commit f8e2ea3

Please sign in to comment.