chore: rearrange serialization export to make APIExtractor happy #6480
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
maribethb
added a commit
to maribethb/blockly
that referenced
this pull request
Oct 4, 2022
Merge branch 'fix/serialization-export' into api-run
maribethb
approved these changes
Oct 4, 2022
3 tasks
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
npm run formatandnpm run lintThe details
Resolves
Fixes #6478
Proposed Changes
Changes the serialization export to use a module rather than a namespace so that hopefully apiextractor / apidocumentor can figure it out.
Reason for Changes
APIExtractor couldn't figure out the namespace declaration in blockly.ts. So hopefully this is better.
Test Coverage
Linked to samples, and the serialization code still works (everything still exists at the same spots on the namespace tree).
Documentation
This is for documentation!
Additional Information
I think the plan is to merge this into develop, and then regen the reference docs based on develop. So this won't actually go into master until the next release. But I'm not 100% sure.