Add support for Roblox internal Stories and Storybooks #29
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
Breaking change: loadStorybookModule's arguments have been reversed. Signature changed from `(ModuleLoader, ModuleScript) -> LoadedStorybook` to `(ModuleScript, ModuleLoader) -> LoadedStorybook`. Loaders are now optional for the consumer to supply
The loader is now instantiated and attached to the storybook implicitly in most cases. This improves sandboxing between storybooks Breaking change: loadStorybookModule's arguments have been reversed. Signature changed from `(ModuleLoader, ModuleScript) -> LoadedStorybook` to `(ModuleScript, ModuleLoader?) -> LoadedStorybook`. Loaders are now optional for the consumer to supply Also keep track of the source module
vocksel
commented
Dec 19, 2024
There was a problem hiding this comment.
Remember to remove this before merging
vocksel
added a commit
that referenced
this pull request
Dec 29, 2024
# Problem A Roblox internal use case requires initializing a particular singleton module only once. This initialization usually happens in storybooks, which are all put into the same module loader. We need to sandbox each storybook's modules to avoid collisions # Solution The loader is now instantiated and attached to the storybook implicitly in most cases. This improves sandboxing between storybooks. This PR was split from #29 > [!IMPORTANT] > Breaking change: `loadStorybookModule`'s arguments have been reversed. Signature changed from `(ModuleLoader, ModuleScript) -> LoadedStorybook` to `(ModuleScript, ModuleLoader?) -> LoadedStorybook`. Loaders are now optional for the consumer to supply
vocksel
commented
Dec 30, 2024
Comment on lines
+14
to
+15
| | `mapDefinition` | `((story: any) -> any)?` | | | ||
| | `mapStory` | `((story: any) -> (props: StoryProps) -> any)?` | | |
There was a problem hiding this comment.
Either add support for mapStory and mapDefinition to all renderers or mark them as Roblox internal only and remove mention from the docs
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.
Problem
Solution