Use any config files: backstop.json, backstop.js #1565
Conversation
| if (options && typeof options.config === 'string' && !customConfigPath) { | ||
| customConfigPath = options.config; | ||
| // list of "config" files to search for | ||
| const configFiles = ['backstop.json', 'backstop.js']; |
There was a problem hiding this comment.
I think all four of these are valid options:
| const configFiles = ['backstop.json', 'backstop.js']; | |
| const configFiles = ['backstop.json', 'backstop.config.json', 'backstop.js', 'backstop.config.js']; |
There was a problem hiding this comment.
@maxfenton Do you REALLY need the support backstop.config.*?
I personally don't mind if we add them, still I don't see it necessary.
@garris ? What do you say?
There was a problem hiding this comment.
@klodoma I have a coworker who — today — said he prefers it on his projects because it’s more clear when looking at the root of a project what's a config file. I'd feel bad if I didn't at least make this suggestion for his sake and since it’s probably the default some other users have been using with the config flag.
There was a problem hiding this comment.
And it’s the default name in the documentation here: https://github.com/garris/BackstopJS?tab=readme-ov-file#working-with-your-config-file
|
This code works for me locally and does exactly what I needed. Thank you. |
| @@ -11,9 +11,7 @@ function main () { | |||
| const argsOptions = parseArgs(process.argv.slice(2), { | |||
| boolean: ['h', 'help', 'v', 'version', 'i', 'docker'], | |||
| string: ['config'], | |||
| default: { | |||
| config: 'backstop.json' | |||
There was a problem hiding this comment.
FWIW: if we change line 15 to config: 'backstop' then require() will resolve this as a .js then a json file on its own. This would be the absolute simplest change. I don't think any other changes would be needed.
What do you guys think? Would this solve the problem?
There was a problem hiding this comment.
Uh, I didn't know that :) good point.
There was a problem hiding this comment.
I will test both today, but I think the docs on the new PR still suggest a backstop.config.js filename and I'm not clear if resolve will find a file with .config in it.
I do like that this PR makes it clear what filenames are allowed and what order of priority they would take.
There was a problem hiding this comment.
I find this PR to be more elegant than v2 which adds a useJs flag that seems extraneous. I think the logic in this PR handles the case where someone has added both a backstop.js and backstop.json in the directory (the json is used because of array priority) and this PR handles more filenames and shows the order of them more explicitly.
That's just my opinion, but I'd vote for this PR over the other one, even though resolve can spot .json and .js
There was a problem hiding this comment.
(And I really appreciate the work in both PR's @klodoma!)
|
I'll close this one. The V2 is the way to go. |
Use any config files: backstop.json, backstop.js whichever is found first.
Discussion here: #1482