-
-
Notifications
You must be signed in to change notification settings - Fork 182
fix: restore docgen auto argTypes (wrong @storybook/react entry point) #903
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
Open
ndelangen
wants to merge
2
commits into
next
Choose a base branch
from
fix/docgen-argtypes-entry-point
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+26
−1
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| --- | ||
| "@storybook/react-native": patch | ||
| --- | ||
|
|
||
| Fix docgen-based auto argTypes (controls) that were silently disabled. `preview.ts` imported `argTypesEnhancers` and `parameters.docs.extractArgTypes` from `@storybook/react/entry-preview-docs`, which does not export them, so both resolved to `undefined`. They are now imported from `@storybook/react/entry-preview-argtypes`, restoring auto-generated controls from component `__docgenInfo`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| import preview from './preview'; | ||
|
|
||
| // Regression test for the entry-point bug where `argTypesEnhancers` and | ||
| // `parameters.docs.extractArgTypes` were imported from | ||
| // `@storybook/react/entry-preview-docs` — which does not export them, so both | ||
| // resolved to `undefined` and docgen-based auto argTypes were silently disabled. | ||
| // They are exported from `@storybook/react/entry-preview-argtypes`. | ||
| describe('preview docgen wiring', () => { | ||
| it('wires argTypesEnhancers from @storybook/react', () => { | ||
| expect(Array.isArray(preview.argTypesEnhancers)).toBe(true); | ||
| expect(preview.argTypesEnhancers?.length).toBeGreaterThan(0); | ||
| preview.argTypesEnhancers?.forEach((enhancer) => { | ||
| expect(typeof enhancer).toBe('function'); | ||
| }); | ||
| }); | ||
|
|
||
| it('wires parameters.docs.extractArgTypes from @storybook/react', () => { | ||
| expect(typeof preview.parameters?.docs?.extractArgTypes).toBe('function'); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure this test adds much value TBH, it only really covers the very specific scenario where we change the entry point structure of
@storybook/react/entry-preview-argtypes. An E2E tests that actually checks for the proper existence of the controls seems a lot more useful here, but I can understand if that is impossible to write in practice.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wish writing e2e tests for RN were as simple as spinning up a playwright instance, but unfortunately, we do not have the infrastructure set up to do this right now.
I agree the test is far from optimal, but it's likely better than not having one.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can typescript not provide the validation for the import existing? this seems like it would validate in the same way or at least it should