Cleaner error handling for storiesOf #672
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Our entire storybook was broken because of a simple error, we provided `undefined` as the first parameter of `storiesOf`. This was pretty hard to track down as it only results in issues later on during the runtime where storybook tries to manipulate the names that were given to the stories.
apexskier
reviewed
Jan 25, 2017
| @@ -24,6 +24,10 @@ export default class ClientApi { | |||
| } | |||
|
|
|||
| storiesOf(kind, m) { | |||
| if (!kind) { | |||
| throw "Invalid kind provided for stories"; | |||
There was a problem hiding this comment.
The build's failing because of a couple simple linting errors.
This should be throw new Error('Invalid kind provided for stories');
Also, remove the whitespace on line 30.
apexskier
reviewed
Jan 25, 2017
| @@ -24,6 +24,10 @@ export default class ClientApi { | |||
| } | |||
|
|
|||
| storiesOf(kind, m) { | |||
| if (!kind) { | |||
There was a problem hiding this comment.
Additionally, it might be nice to have this be !kind && typeof kind !== 'string' to be a bit stricter
|
Applied the changes |
apexskier
approved these changes
Jan 26, 2017
|
Can we get this merged? Just stumbled upon the exact same issue again today causing a search for half an hour :) |
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Our entire storybook was broken because of a simple error, we provided
undefinedas the first parameter ofstoriesOf.This was pretty hard to track down as it only results in issues later on during the runtime where storybook tries to manipulate the names that were given to the stories.
If you want I can write extra tests for this usecase, but I would like to know if this is something you want to work on first.