[LG-5451] feat(code-editor): add preLoadedModules prop for synchronous module loading #3107
Conversation
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
…nagement - Introduced a new `preLoadedModules` prop to the CodeEditor component, allowing users to provide pre-loaded modules instead of relying solely on lazy loading. - Implemented logic to determine missing required modules and issue console warnings if any are not provided, enhancing user feedback. - Updated the module loading process to utilize pre-loaded modules when available, improving performance and ensuring synchronous behavior. - Enhanced TypeScript definitions to include the new `preLoadedModules` prop, ensuring better type safety and clarity for users.
…s hook - Replaced the previous module loading approach with a new `useModules` hook to streamline the management of core and formatting modules. - Removed redundant code related to missing module checks and lazy loading, enhancing clarity and maintainability. - Updated the CodeEditor component to utilize the new hook, ensuring consistent module handling across functionalities. - Improved TypeScript definitions for better type safety and clarity in module management.
…ests - Introduced a new story, `WithPreLoadedModules`, to demonstrate the usage of pre-loaded modules in the CodeEditor component, enhancing the flexibility of module management. - Updated the `CodeEditor.spec.tsx` to include tests for rendering the editor with pre-loaded modules, ensuring immediate rendering and functionality. - Refactored the `useModules` hook to streamline module loading logic when pre-loaded modules are provided, improving performance and clarity. - Enhanced TypeScript definitions to support the new pre-loaded modules feature, ensuring better type safety and usability.
- Changed the test flag from `test.only` to `test` in `CodeEditor.spec.tsx` to ensure all tests run. - Introduced a new test suite for the `useModules` hook in `useModules.spec.ts`, covering scenarios for loading states and module retrieval based on provided pre-loaded modules. - Enhanced test coverage for module loading behavior, ensuring accurate handling of both provided and default modules.
…leteness - Revised the properties table in the CodeEditor README to enhance clarity and organization. - Added the `preLoadedModules` property to the table, providing details on its usage and type. - Ensured consistent formatting and alignment of property descriptions for improved readability. - Updated the documentation to reflect recent changes and features, ensuring users have accurate information on available props.
|
tsck
commented
Sep 5, 2025
There was a problem hiding this comment.
This is meant to just extract all of the module loading logic out of the CodeEditor component
|
Size Change: +178 B (+0.01%) Total Size: 2.04 MB
ℹ️ View Unchanged
|
TheSonOfThomp
approved these changes
Sep 8, 2025
…en-ui into LG-5451/cs-sync-modules
tsck
added a commit
that referenced
this pull request
Sep 15, 2025
…s module loading (#3107) * feat(CodeEditor): add preLoadedModules support for improved module management - Introduced a new `preLoadedModules` prop to the CodeEditor component, allowing users to provide pre-loaded modules instead of relying solely on lazy loading. - Implemented logic to determine missing required modules and issue console warnings if any are not provided, enhancing user feedback. - Updated the module loading process to utilize pre-loaded modules when available, improving performance and ensuring synchronous behavior. - Enhanced TypeScript definitions to include the new `preLoadedModules` prop, ensuring better type safety and clarity for users. * refactor(CodeEditor): consolidate module loading logic with useModules hook - Replaced the previous module loading approach with a new `useModules` hook to streamline the management of core and formatting modules. - Removed redundant code related to missing module checks and lazy loading, enhancing clarity and maintainability. - Updated the CodeEditor component to utilize the new hook, ensuring consistent module handling across functionalities. - Improved TypeScript definitions for better type safety and clarity in module management. * feat(CodeEditor): add support for pre-loaded modules in stories and tests - Introduced a new story, `WithPreLoadedModules`, to demonstrate the usage of pre-loaded modules in the CodeEditor component, enhancing the flexibility of module management. - Updated the `CodeEditor.spec.tsx` to include tests for rendering the editor with pre-loaded modules, ensuring immediate rendering and functionality. - Refactored the `useModules` hook to streamline module loading logic when pre-loaded modules are provided, improving performance and clarity. - Enhanced TypeScript definitions to support the new pre-loaded modules feature, ensuring better type safety and usability. * test(CodeEditor): remove exclusive test flag and add useModules tests - Changed the test flag from `test.only` to `test` in `CodeEditor.spec.tsx` to ensure all tests run. - Introduced a new test suite for the `useModules` hook in `useModules.spec.ts`, covering scenarios for loading states and module retrieval based on provided pre-loaded modules. - Enhanced test coverage for module loading behavior, ensuring accurate handling of both provided and default modules. * docs(README): update CodeEditor properties table for clarity and completeness - Revised the properties table in the CodeEditor README to enhance clarity and organization. - Added the `preLoadedModules` property to the table, providing details on its usage and type. - Ensured consistent formatting and alignment of property descriptions for improved readability. - Updated the documentation to reflect recent changes and features, ensuring users have accurate information on available props.
tsck
added a commit
that referenced
this pull request
Sep 16, 2025
…s module loading (#3107) * feat(CodeEditor): add preLoadedModules support for improved module management - Introduced a new `preLoadedModules` prop to the CodeEditor component, allowing users to provide pre-loaded modules instead of relying solely on lazy loading. - Implemented logic to determine missing required modules and issue console warnings if any are not provided, enhancing user feedback. - Updated the module loading process to utilize pre-loaded modules when available, improving performance and ensuring synchronous behavior. - Enhanced TypeScript definitions to include the new `preLoadedModules` prop, ensuring better type safety and clarity for users. * refactor(CodeEditor): consolidate module loading logic with useModules hook - Replaced the previous module loading approach with a new `useModules` hook to streamline the management of core and formatting modules. - Removed redundant code related to missing module checks and lazy loading, enhancing clarity and maintainability. - Updated the CodeEditor component to utilize the new hook, ensuring consistent module handling across functionalities. - Improved TypeScript definitions for better type safety and clarity in module management. * feat(CodeEditor): add support for pre-loaded modules in stories and tests - Introduced a new story, `WithPreLoadedModules`, to demonstrate the usage of pre-loaded modules in the CodeEditor component, enhancing the flexibility of module management. - Updated the `CodeEditor.spec.tsx` to include tests for rendering the editor with pre-loaded modules, ensuring immediate rendering and functionality. - Refactored the `useModules` hook to streamline module loading logic when pre-loaded modules are provided, improving performance and clarity. - Enhanced TypeScript definitions to support the new pre-loaded modules feature, ensuring better type safety and usability. * test(CodeEditor): remove exclusive test flag and add useModules tests - Changed the test flag from `test.only` to `test` in `CodeEditor.spec.tsx` to ensure all tests run. - Introduced a new test suite for the `useModules` hook in `useModules.spec.ts`, covering scenarios for loading states and module retrieval based on provided pre-loaded modules. - Enhanced test coverage for module loading behavior, ensuring accurate handling of both provided and default modules. * docs(README): update CodeEditor properties table for clarity and completeness - Revised the properties table in the CodeEditor README to enhance clarity and organization. - Added the `preLoadedModules` property to the table, providing details on its usage and type. - Ensured consistent formatting and alignment of property descriptions for improved readability. - Updated the documentation to reflect recent changes and features, ensuring users have accurate information on available props.
tsck
added a commit
that referenced
this pull request
Sep 16, 2025
…s module loading (#3107) * feat(CodeEditor): add preLoadedModules support for improved module management - Introduced a new `preLoadedModules` prop to the CodeEditor component, allowing users to provide pre-loaded modules instead of relying solely on lazy loading. - Implemented logic to determine missing required modules and issue console warnings if any are not provided, enhancing user feedback. - Updated the module loading process to utilize pre-loaded modules when available, improving performance and ensuring synchronous behavior. - Enhanced TypeScript definitions to include the new `preLoadedModules` prop, ensuring better type safety and clarity for users. * refactor(CodeEditor): consolidate module loading logic with useModules hook - Replaced the previous module loading approach with a new `useModules` hook to streamline the management of core and formatting modules. - Removed redundant code related to missing module checks and lazy loading, enhancing clarity and maintainability. - Updated the CodeEditor component to utilize the new hook, ensuring consistent module handling across functionalities. - Improved TypeScript definitions for better type safety and clarity in module management. * feat(CodeEditor): add support for pre-loaded modules in stories and tests - Introduced a new story, `WithPreLoadedModules`, to demonstrate the usage of pre-loaded modules in the CodeEditor component, enhancing the flexibility of module management. - Updated the `CodeEditor.spec.tsx` to include tests for rendering the editor with pre-loaded modules, ensuring immediate rendering and functionality. - Refactored the `useModules` hook to streamline module loading logic when pre-loaded modules are provided, improving performance and clarity. - Enhanced TypeScript definitions to support the new pre-loaded modules feature, ensuring better type safety and usability. * test(CodeEditor): remove exclusive test flag and add useModules tests - Changed the test flag from `test.only` to `test` in `CodeEditor.spec.tsx` to ensure all tests run. - Introduced a new test suite for the `useModules` hook in `useModules.spec.ts`, covering scenarios for loading states and module retrieval based on provided pre-loaded modules. - Enhanced test coverage for module loading behavior, ensuring accurate handling of both provided and default modules. * docs(README): update CodeEditor properties table for clarity and completeness - Revised the properties table in the CodeEditor README to enhance clarity and organization. - Added the `preLoadedModules` property to the table, providing details on its usage and type. - Ensured consistent formatting and alignment of property descriptions for improved readability. - Updated the documentation to reflect recent changes and features, ensuring users have accurate information on available props.
tsck
added a commit
that referenced
this pull request
Sep 18, 2025
…s module loading (#3107) * feat(CodeEditor): add preLoadedModules support for improved module management - Introduced a new `preLoadedModules` prop to the CodeEditor component, allowing users to provide pre-loaded modules instead of relying solely on lazy loading. - Implemented logic to determine missing required modules and issue console warnings if any are not provided, enhancing user feedback. - Updated the module loading process to utilize pre-loaded modules when available, improving performance and ensuring synchronous behavior. - Enhanced TypeScript definitions to include the new `preLoadedModules` prop, ensuring better type safety and clarity for users. * refactor(CodeEditor): consolidate module loading logic with useModules hook - Replaced the previous module loading approach with a new `useModules` hook to streamline the management of core and formatting modules. - Removed redundant code related to missing module checks and lazy loading, enhancing clarity and maintainability. - Updated the CodeEditor component to utilize the new hook, ensuring consistent module handling across functionalities. - Improved TypeScript definitions for better type safety and clarity in module management. * feat(CodeEditor): add support for pre-loaded modules in stories and tests - Introduced a new story, `WithPreLoadedModules`, to demonstrate the usage of pre-loaded modules in the CodeEditor component, enhancing the flexibility of module management. - Updated the `CodeEditor.spec.tsx` to include tests for rendering the editor with pre-loaded modules, ensuring immediate rendering and functionality. - Refactored the `useModules` hook to streamline module loading logic when pre-loaded modules are provided, improving performance and clarity. - Enhanced TypeScript definitions to support the new pre-loaded modules feature, ensuring better type safety and usability. * test(CodeEditor): remove exclusive test flag and add useModules tests - Changed the test flag from `test.only` to `test` in `CodeEditor.spec.tsx` to ensure all tests run. - Introduced a new test suite for the `useModules` hook in `useModules.spec.ts`, covering scenarios for loading states and module retrieval based on provided pre-loaded modules. - Enhanced test coverage for module loading behavior, ensuring accurate handling of both provided and default modules. * docs(README): update CodeEditor properties table for clarity and completeness - Revised the properties table in the CodeEditor README to enhance clarity and organization. - Added the `preLoadedModules` property to the table, providing details on its usage and type. - Ensured consistent formatting and alignment of property descriptions for improved readability. - Updated the documentation to reflect recent changes and features, ensuring users have accurate information on available props.
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.
✍️ Proposed changes
This change adds a new
preLoadedModulesprop to the CodeEditor component that enables synchronous module loading by allowing consumers to pre-load required CodeMirror modules instead of relying on the default lazy loading behavior. This eliminates the initial loading state when all necessary modules are provided upfront.The implementation introduces a new
useModuleshook that consolidates the previous separate core and formatting module loading logic, providing a unified interface that handles both pre-loaded modules and lazy loading scenarios with proper fallback behavior.🎟️ Jira ticket: LG-5451
✅ Checklist
pnpm changesetand documented my changes🧪 How to test changes
Test the new preLoadedModules prop:
Test backward compatibility:
Test console warnings:
Run the test suite:
pnpm test packages/code-editor🎟 Jira ticket: LG-5451