fix: Fix incorrect Blockly imports #2339
Merged
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
We have for some time promulgated
import * as Blockly from 'blockly/core';
as the correct way to import Blockly in our documentation.
Update our own plugins and templates to match.
Because we have been packaging Blockly until now only as CJS
modules, and CJS modules always provide an (unnamed) default
export consisting of the module.exports object, importing
Blockly with
import Blockly from 'blockly/core';
(note no "*") has worked fine (and similarly for all the
other entrypoints).
As the sources for the entrypoints (core/blockly.ts,
blocks/blocks.ts, etc.) do not explicitly declare a default
export, however, this should not be relied upon: when we start
shipping Blockly as pure-ESM there will be no default export
and so "import Blockly from …" will stop working.
maribethb
approved these changes
May 2, 2024
1 task
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.
The basics
The details
Proposed Changes
We have for some time promulgated
as the correct way to import Blockly in our documentation. Update our own plugins and templates to match.
Reason for Changes
Because we have been packaging Blockly until now only as CJS modules, and CJS modules always provide an (unnamed) default export consisting of the module.exports object, importing Blockly with
(note no
*) has worked fine (and similarly for all the other entrypoints).As the sources for the entrypoints (
core/blockly.ts,blocks/blocks.ts, etc.) do not explicitly declare adefaultexport, however, this should not be relied upon: when we start shipping Blockly as pure-ESM there will be no default export and soimport Blockly from …will stop working.