Feature Request: JSON output

[petermikitsh]

It would be useful if Chromatic CLI could output, for example, something like this (note: I am open to whatever JSON shape the Chromatic team would prefer):

{
  "statusCode": 1,
  "statusKey": "BUILD_HAS_CHANGES",
  "reviewUrl": "https://www.chromatic.com/build?appId=[REDACTED]&number=2",
}

I could then parse this with a tool like jq and leave a comment on my PR using the gh cli.

OUTPUT=$(npx --no-install chromatic --project-token=REDACTED)

REVIEW_URL=$(echo '$OUTPUT' | jq -r '.reviewUrl')

gh pr comment $CHANGE_ID \
  -b "[BOT] <details><summary>Your PR has visual diff failures:</summary>$REVIEW_URL</details>" \
  --repo $GIT_REPO_PATH

[kylesuss]

Hi @petermikitsh 👋

Do you just want the format to be JSON for ease in parsing? Is there any extra information in the JSON object compared to the current output?

[petermikitsh]

Do you just want the format to be JSON for ease in parsing?

Correct, yes! To expand on the request, I would imagine the CLI would expect some sort of output parameter, eg:

- OUTPUT=$(npx --no-install chromatic --project-token=REDACTED)
+ OUTPUT=$(npx --no-install chromatic --project-token=REDACTED --output json)

Is there any extra information in the JSON object compared to the current output?

I'm still familiarizing myself with the CLI, but the main pieces of useful output would be:

• total number of test cases
• number of passing cases
• number of failing cases
• percentage of passing test cases
• link to the review url

Taking a step back, I just want to be able to effectively utilize a PR comment as a call-to-action for developers, so they don't have to dig through the log output to identify the reason of why their build is failing.

I'm migrating my projects from puppeteer storyshots to Chromatic. In this existing workflow, the PR comment on failure would look something like this, and developers would know to push another commit with updated baseline images:

[tmeasday]

@petermikitsh have you seen the --junit-report flag? This is a fairly standard output format that I think contains the info you need.

[codykaup]

We've had a few requests for something like this. I wrote up an internal project so we can discuss adding this feature in the future. Unfortunately, there's no guarantees we'll have time to work on it.

If you'd like to see JSON output added, feel free to leave a 👍 on this issue so we have a clearer picture of the impact!