Storysource: Fallback to the docs.source.originalSource
parameter
#21159
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.
Closes #20421
What I did
Fallback to us the source provided by the
docs.source.originalSource
parameter.There is a long history to this hack of a PR. The TLDR is that:
source-loader
in thestorySource.source
parameter. However,source-loader
caused a performance regression in the Vite builder, so I reverted it.csf-plugin
runs always (currently), so we can expect thedocs.source.originalSource
to be there.The addon will prefer
storySource.source
for legacy support, but also usedocs.source.originalSource
if it's not there.Note that in webpack:
source-loader
IS runcsf-plugin
IS NOT run unlessaddon-docs
is enabledHopefully this all gets replaced with the annotation server in 7.x...
How to test
Run a Vite sandbox with the storysource addon:
Verify that the code shows up in the
Code
addon panel.