Docs: Fix attachment logic #20531
Merged
Docs: Fix attachment logic #20531
Conversation
This file contains 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
JReinhold
requested changes
Jan 9, 2023
| const resolved = this.resolveModuleExport(metaExports); | ||
| if (resolved.type !== 'meta') | ||
| throw new Error('Cannot reference a non-meta or module export in <Meta of={} />'); | ||
| this.attachCSFFile(resolved.csfFile); | ||
| } | ||
|
|
||
| resolveModuleExport(moduleExport: ModuleExport, metaExports?: ModuleExports) { |
There was a problem hiding this comment.
We decided that resolveModuleExport(undefined) would:
- Unattached: throw a nice error like "Cannot resolve an undefined module export in an unattached doc" (a
useOfhook in blocks would make this error more user-friendly) - Attached: return the primary story.
I think we should have that in this PR, along with an a matching test case.
|
Merging this in to the parent PR for simplicity, thanks folks! |
tmeasday
deleted the
tom/sb-1122-sb19964-bug-unable-to-use-description-2
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Telescoping on #20517
What I did
Rationalized how attachment works:
For CSF (template) files, we attach to the (one or more) CSF files we are templating, immediately. (You can have more than one with autodocs and stories spread over > 1 CSF file.
For MDX files, we attach when you call
<Meta of={} />.How to test