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

Addon-docs: Component parameter codemod #7155

Merged
merged 2 commits into from Jun 22, 2019
Merged

Addon-docs: Component parameter codemod #7155

merged 2 commits into from Jun 22, 2019

Conversation

shilman
Copy link
Member

@shilman shilman commented Jun 20, 2019

Issue: #7101

What I did

Storybook docs DocsPage requires that a user specify the target component as a parameter. This codemod tries to automatically add it to your storiesOf stories.

storiesOf('path/to/MyComponent', module).add(....)

=>

storiesOf('path/to/MyComponent', module)
  .addParameters({ component: MyComponent })
  .add(....)

How to test

yarn test --core

Also you can see the results of running this on the storybook codebase in the second commit.

@shilman shilman added this to the 5.2.0 milestone Jun 20, 2019
@vercel
Copy link

vercel bot commented Jun 20, 2019 •
edited

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://monorepo-git-7101-component-param-codemod.storybook.now.sh

@shilman shilman mentioned this pull request Jun 20, 2019
Closed
21 tasks
tmeasday
tmeasday approved these changes Jun 21, 2019
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.

LGTM.

lib/codemod/src/transforms/add-component-parameters.js
);

function getLeafName(string) {
const parts = string.split(/\/|\.|\|/);
Copy link
Member

Choose a reason for hiding this comment

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

What if they use a different path separator? Are the SOL?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah. Any suggestions here?

@shilman shilman merged commit 4265565 into next Jun 22, 2019
@shilman shilman deleted the 7101-component-param-codemod branch June 22, 2019 01:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tmeasday tmeasday tmeasday approved these changes

@aaronmcadam aaronmcadam Awaiting requested review from aaronmcadam

@alexandrebodin alexandrebodin Awaiting requested review from alexandrebodin

@danielduan danielduan Awaiting requested review from danielduan

@Gongreg Gongreg Awaiting requested review from Gongreg

@igor-dv igor-dv Awaiting requested review from igor-dv

@ndelangen ndelangen Awaiting requested review from ndelangen

@thomasbertet thomasbertet Awaiting requested review from thomasbertet

@usulpro usulpro Awaiting requested review from usulpro

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

Successfully merging this pull request may close these issues.

None yet
2 participants
@shilman @tmeasday