From 60c040d3c4af4e9fd4891f7d0a09dfde5d33ebc5 Mon Sep 17 00:00:00 2001 From: Andrei Bintintan Date: Wed, 1 May 2024 09:02:39 +0200 Subject: [PATCH] Use any config file: backstop.json, backstop.js --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7a6a340e..36785b1c 100644 --- a/README.md +++ b/README.md @@ -104,6 +104,8 @@ BackstopJS can create a default configuration file and project scaffolding in yo backstop init ``` +Use `backstop init --js` to initialize the project with a `.js` configuration file. + ### Working with Your Config File By default, BackstopJS places `backstop.json` in the root of your project. And also by default, BackstopJS looks for this file when invoked. @@ -112,9 +114,9 @@ Pass a `--config=` argument to test using a different config **JS based config file** -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_. +You may use a javascript based config file to allow the use of comments and more complex configurations. Be sure to _export your config object as a node module_. -Example: Create a backstop.config.js +Example: Create a `backstop.config.js` ``` module.exports = { Same object as backstop.json }