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.
What I did
This is my attempt to solve the issues I am having with the mdx-to-csf migration.
I realize that these code transformations might be too opinionated for the general audience.
So please tell me which ones are fine, and which ones should be refined, removed or somehow made optional.
Otherwise eslint-plugin-storybook complains.
I have widened the existing logic to deduplicate identifiers, that appends an underscore.
TODO: I have to add the case of default exports, because that is how vue components are usually imported.
Here I am removing all exports from the .mdx result files.
Earlier I also removed all imports which are not for doc blocks, but I encountered an instance in my own project where the component was imported to be used with ArgsTable.
So for the imports I opted for the unused-imports eslint-plugin instead.
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Are the snapshots in
code/lib/codemod/src/transform/__testfixtures__/mdx-to-csf
used anywhere? How can I check them locally?Manual testing
I have tested the code mod with a local project and it works as expected.
Documentation
Is there any documentation regarding the codemod that should be updated?
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal
,ci:merged
orci:daily
GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
bug
: Internal changes that fixes incorrect behavior.maintenance
: User-facing maintenance tasks.dependencies
: Upgrading (sometimes downgrading) dependencies.build
: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup
: Minor cleanup style change. Will not show up in release changelog.documentation
: Documentation only changes. Will not show up in release changelog.feature request
: Introducing a new feature.BREAKING CHANGE
: Changes that break compatibility in some way with current major version.other
: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/core
team here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>