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

feat(createStoryMetaSettings): allow generating internal stories and autodocs page with metasettings helper #2079

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

YossiSaadi
Copy link
Contributor

@YossiSaadi YossiSaadi commented Apr 21, 2024

Note: this PR is on hold, because of a bug from Storybook's side

This PR aims to manage the tags "backstage" for internal stories
It also enables creating autodocs page, with not much info (would mainly be used for internal components)

image

image

@@ -34,9 +34,6 @@ const config: StorybookConfig = {
name: "@storybook/react-webpack5",
options: {}
},
docs: {
autodocs: false
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default is not true, default is tags, meaning only stories which define tags: ["autodocs"] would get autodocs page. It's good for internal components to get a "free" docs page

@YossiSaadi YossiSaadi marked this pull request as ready for review April 21, 2024 14:18
@YossiSaadi YossiSaadi requested a review from a team as a code owner April 21, 2024 14:18
Copy link
Contributor

@talkor talkor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome

@YossiSaadi
Copy link
Contributor Author

Awesome

@talkor Can't determine why it fails.
When I print the metasettings.tags it returns a proper array

@talkor
Copy link
Contributor

talkor commented Apr 24, 2024

Awesome

@talkor Can't determine why it fails. When I print the metasettings.tags it returns a proper array

What fails?

@YossiSaadi
Copy link
Contributor Author

Awesome

@talkor Can't determine why it fails. When I print the metasettings.tags it returns a proper array

What fails?

WARN 🚨 Unable to index ./src/components/BaseInput/__stories__/BaseInput.stories.tsx:
WARN   Error: CSF: Expected tags array

will leave it for now

@YossiSaadi
Copy link
Contributor Author

@talkor storybookjs/storybook#26940
It's a bug on Storybook's side

@talkor
Copy link
Contributor

talkor commented Apr 24, 2024

@talkor storybookjs/storybook#26940 It's a bug on Storybook's side

oh no :/

@YossiSaadi YossiSaadi marked this pull request as draft April 30, 2024 06:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants