Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Unclear documentation for storyKindRegex and "story kinds" #7996

Closed
worc opened this issue Sep 4, 2019 · 5 comments
Closed

Unclear documentation for storyKindRegex and "story kinds" #7996

worc opened this issue Sep 4, 2019 · 5 comments

Comments

@worc
Copy link

worc commented Sep 4, 2019

What is a "story kind"? I'm trying to work with the storyKindRegex, but I'm not finding any documentation on what a story kind is. Is it a reference to a file name? File extension? Something to do with the component type? The storybook entry strings?

@worc worc changed the title Unclear documentation Unclear documentation for storyKindRegex and "story kinds" Sep 4, 2019
@shilman
Copy link
Member

shilman commented Sep 5, 2019

Story kind is the first arg to storiesOf. In the following, the kind is MyComponent:

storiesOf('MyComponent', module).add(...)

storyKindRegex is a way to only include certain kinds ("components") in your snapshot tests.

@holmesal
Copy link

holmesal commented Sep 5, 2019

How can we exclude individual stories by name?

@sergej-s
Copy link

@holmesal It seems that adding storyNameRegex along with storyKindRegex does work:

storyKindRegex: /^MyComponent$/,
storyNameRegex: /^((?!.*?DontTest).)*$/,
storiesOf('MyComponent', module)
  .add(`Playground (DontTest)`, () => {
     ...

@stale
Copy link

stale bot commented Oct 7, 2019

Hi everyone! Seems like there hasn't been much going on in this issue lately. If there are still questions, comments, or bugs, please feel free to continue the discussion. Unfortunately, we don't have time to get to every issue. We are always open to contributions so please send us a pull request if you would like to help. Inactive issues will be closed after 30 days. Thanks!

@stale
Copy link

stale bot commented Nov 6, 2019

Hey there, it's me again! I am going close this issue to help our maintainers focus on the current development roadmap instead. If the issue mentioned is still a concern, please open a new ticket and mention this old one. Cheers and thanks for using Storybook!

@stale stale bot closed this as completed Nov 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants