garris / BackstopJS

Catch CSS curve balls.
http://backstopjs.org
MIT License
6.69k stars 604 forks source link

Add --verbose parameter to backstop commands to show error details #1389

Open JPustkuchen opened 2 years ago

JPustkuchen commented 2 years ago

Problem:

When running into a problem with unknown reason like the following, typically a "--verbose" parameter helps to show details:

$ backstop reference
COMMAND | Executing core for "reference"
  clean | backstop_data/bitmaps_reference was cleaned.
createBitmaps | Selected 71 of 71 scenarios.
      COMMAND | Command "reference" ended with an error after [0.574s]
      COMMAND | [object Object]

backstop uses -v for version. Typically this is "verbose". A verbose parameter doesn't seem to exist

Proposed solution:

Introduce --verbose which shows more details about the process and replace -v for version with -v for verbose Especially the [object Object] is a problem as it shows no information about the problems.

garris commented 2 years ago

There is a debug setting in the config "debugWindow": true which enables verbose logs. Check the readme.

JPustkuchen commented 2 years ago

Thank you for your super fast reply @garris! What do you think about dynamically overriding that settings via --verbose?

I think that would be quite intuitive. But just a suggestion of course, you're the maintainer.

garris commented 2 years ago

That's not something I would want to change at this point. -v is already in use as a version check -- changing it could break hundreds of implantations. So, too costly.

JPustkuchen commented 2 years ago

Ok thank you very much @garris - feel free to do whatever you like with this request. If you think the idea might still make sense in the far future, postpone it. Otherwise I'll of course also accept your decision to close it.

Let me leave a huge THANK YOU, this project is really, really great work! Thank you for spending your time on it.