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.

Sign up for GitHub

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

Jump to bottom

CSF-tools: Turn story comments into docs descriptions #19684

Merged
merged 9 commits into from Nov 1, 2022
Merged

CSF-tools: Turn story comments into docs descriptions #19684

merged 9 commits into from Nov 1, 2022

Conversation

shilman
Copy link
Member

@shilman shilman commented Oct 29, 2022 •
edited by issuehunt-oss bot

Issue: #8527

Credit to @izhan for paving the way https://github.com/izhan/storybook-description-loader

What I did

Telescopes off #19680

  • Parse out comments that start with /** and add them as docs.description.story parameters
  • Made it a loader so that it receives the original file with comments
  • Preserve user indentation
  • Added plugin options
  • Correctly merge generated parameters with user parameters
  • Made it async for performance

How to test

  • CI passes
  • Test it out in ui storybook or CRA sandbox
IssueHunt Summary

Referenced issues

This pull request has been submitted to:

@shilman shilman force-pushed the shilman/csf-plugin-docgen-description branch from de1296d to 2c4c25d Compare October 29, 2022 13:32
@shilman shilman mentioned this pull request Oct 29, 2022
Merged
6 tasks
JReinhold
JReinhold reviewed Oct 29, 2022
View reviewed changes
code/lib/csf-tools/src/enrichCsf.ts Outdated Show resolved Hide resolved
code/lib/csf-tools/src/enrichCsf.ts Outdated Show resolved Hide resolved
@shilman shilman changed the title CSF-tools: Turn story comments into docs descriptions WIP CSF-tools: Turn story comments into docs descriptions Oct 31, 2022
@shilman shilman marked this pull request as ready for review October 31, 2022 16:32
tmeasday
tmeasday approved these changes Nov 1, 2022
View reviewed changes
Copy link
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

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

Awesome!

code/lib/csf-tools/src/enrichCsf.ts Outdated Show resolved Hide resolved
@shilman shilman merged commit 75f1cb6 into shilman/csf-plugin Nov 1, 2022
@shilman shilman deleted the shilman/csf-plugin-docgen-description branch November 1, 2022 03:30
@shilman shilman mentioned this pull request Nov 1, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JReinhold JReinhold JReinhold left review comments

@tmeasday tmeasday tmeasday approved these changes

Assignees
No one assigned
Labels
addon: docs feature request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@shilman @tmeasday @JReinhold