Use any config files: backstop.json, backstop.js - Version 2

[klodoma]

Use any config files: backstop.json, backstop.js whichever is found first.

Discussion here: #1482

Changes:

• by default look for backstop.js or backstop.json
• adjusted the init function to handle properly the initialization
  • also added the option to init with --js flag
• updated readme

[maxfenton]

I might be wrong, but I don't think this PR would automatically find a backstop.config.js so this example should be changed to

Example: Create a `backstop.js`

[garris]

This is correct -- but I don't think this is necessary.

[garris]

I have no problem removing the file extension so that advanced users can easily interchange file types implicitly. This is how require() was intended to work.

The intention of init is to...

1. make it easy for novice users to get started with Backstop JS
2. enable basic automated sanity testing

I am not inclined to add another file format generation to init -- I don't think this moves the objectives forward. If anything -- awareness of js config option to me is more of a problem -- as measured by users' questions in this area. Perhaps emphasising this in the docs or in example code would more directly address the issue?

[klodoma]

I am not inclined to add another file format generation to init -- I don't think this moves the objectives forward.

@garris

Imo I think this project should switch from .json to .js config file. We'll keep the "backward" compatibility through the require feature.

So, my proposal would be:

• we keep the config as it is, this will work for both .json and .js
• init will generate a .js file by default - so almost going back to the current code
• we update the documentation so that .js is by default used
• old projects that use the .json format will still work.
• everybody's happy and this would be a "evolution"

[solomonhawk]

Any consideration for using https://github.com/cosmiconfig/cosmiconfig? It might be nice to offload the work to a separate well-tested, fully-featured library and allow backdrop to give end-users the flexibility that they might expect coming from other ecosystem packages that use cosmiconfig.

[maxfenton]

@garris @klodoma Just wondering if any version of this solution can be merged.

[garris]

@maxfenton I would be willing to merge a PR for just this change. It opens up possibilities with the lightest touch.

[klodoma]

@garris
That would be the second PR.

I didn't hat time anymore I'll have a second look and let you know.

[garris]

I just made the change. Hope this is helpful. Will go out in next release. 944884b