chromatic-cli icon indicating copy to clipboard operation
chromatic-cli copied to clipboard

Surface story/component details when we experience parsing issues with parameters

Open kylesuss opened this issue 5 years ago • 0 comments

When a parsing error happens on a story's parameters, any errors during this process could use more context around the specific story that caused the issue. I had a customer write into support with something that made me think we removed functionality for supporting the viewports parameter as a function, but it ended up that the person had 1 story that was passing a number to the viewports, like this:

Story.parameters = {
  chromatic: { viewports: 1000 },
}

An error surfaced (see below :point_down: ) but it wasn't helpful in understanding the true issue. Perhaps we could surface the story name that caused the issue. Thoughts?

EDIT: The original issue is included below. The problem ended up being different, but I left it for context.


I had a customer write into support with an error that indicated our CLI was having trouble reading their viewports parameter.

✖ Failed to verify your Storybook\nparameters.viewports.find is not a function

They shared this link of our past support for this feature:

https://github.com/chromaui/chromatic-cli/blob/next/CHANGELOG.md#210---2019-07-17

It seems the new version of the CLI does not support viewports when they are a function. Was that intentional or perhaps just a small oversight in the refactor of the CLI?

┆Issue is synchronized with this Asana task by Unito

kylesuss avatar Jun 26 '20 20:06 kylesuss