garris / garris/BackstopJS

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

Open
#1,389 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
7.2k
Forks
621
PR merge metrics
No merged PRs in 30d

Description

### 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.

Contributor guide

Open the contributing guide

Research direction

Start at the CLI option parsing used by `backstop reference`, then reproduce the shown failure and trace how its error becomes `[object Object]`. Check the existing `-v` version handling before deciding how the proposed flag change fits. Done means a verbose option exposes useful error details and the command behavior is covered by the project’s relevant checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.