Convert a few Blockly files to TypeScript #56314
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
|
This PR is a continuation of #56171, which was mis-closed by the Git LFS migration (#55759). Previous Comments:Previous Reviews:
|
mikeharv
approved these changes
Feb 5, 2024
| if (mainWorkspaceFlyout) { | ||
| mainWorkspaceFlyout.reflow(); | ||
| } | ||
| mainWorkspace?.getFlyout()?.reflow(); |
| @@ -7,14 +7,15 @@ import { | |||
| import moduleStyles from './modal-function-editor.module.scss'; | |||
| import classNames from 'classnames'; | |||
| import Button from '@cdo/apps/templates/Button'; | |||
| import msg from '@cdo/locale'; | |||
| import {commonI18n} from '@cdo/apps/types/locale'; | |||
There was a problem hiding this comment.
Thanks for including the link about this particular change!
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.
Initial steps at adding some TypeScript to our Blockly code. I just converted a couple files here:
constants.js->constants.ts: the only change that was needed here was typing the parameters of two functions. We also were explicitly importing things from this file viaconstants.js, so I updated those imports to just be fromconstants.ModalFunctionEditor.jsx->ModalFunctionEditor.tsx: our only React component in the blockly folder. All that was required here was typing the state from redux and changing the locale import to the TypeScript version (see TypeScript locale completion #53623 for details on this)utils.js->utils.ts: this one was more interesting:reducein TypeScript utilizes generics, so you need to add a type to your call ofreduceto specify what type it will return.findFlyout, which relied on private fields in Blockly'sWorkspaceSvgclass (flyoutandtoolbox_.flyout_. If we want to use TypeScript here, we could not reference a private field. I looked atWorkspaceSvgto see if there was an alternative. Very conveniently,WorkspaceSvg.getFlyout()was doing the exact same thing as this entire function (code). Therefore I replaced use of this function with blockly's function instead (it was only used in one place,eventHandlers). We may not always get such a neat solution for our use of private fields, but this one ended up making our code shorter.Links
Testing story
I tested locally that Google Blockly labs (Dance Party and Sprite Lab on google blockly) still worked as expected, specifically around the modal function editor and browser resizing, which is what this touched.
Follow-up work
I am spending this week trying to move some of our Blockly code to TypeScript, so expect more PRs like this. I am trying to keep each PR relatively small and low risk.
PR Checklist: