feat: updates accessors for getMainWorkspace and getSelected #6313
Conversation
core/blockly.ts
Outdated
| @@ -315,14 +315,19 @@ export function hideChaff(opt_onlyClosePopups?: boolean) { | |||
| * Returns the main workspace. Returns the last used main workspace (based on | |||
| * focus). Try not to use this function, particularly if there are multiple | |||
| * Blockly instances on a page. | |||
| * @return The main workspace. | |||
| * @see Blockly.common.getMainWorkspace | |||
| * @alias Blockly.getMainWorkspace | |||
| */ | |||
| // AnyDuringMigration because: Property 'getMainWorkspace' does not exist on | |||
| // type 'void'. | |||
| export const getMainWorkspace = (common as AnyDuringMigration).getMainWorkspace; | |||
There was a problem hiding this comment.
Is this cast actually necessary or can it be removed?
There was a problem hiding this comment.
Removed all instances of AnyDuringMigration from blockly.ts except for the one in populateProcedures since I want to get rid of that as part of the shared procedures project anyway, and it's not external facing.
| @@ -85,9 +85,15 @@ Object.defineProperties(Blockly, { | |||
| */ | |||
| mainWorkspace: { | |||
| set: function(x) { | |||
There was a problem hiding this comment.
Here and for selected, the deprecation notice for set*() doesn't really make sense since it points you to the getter.
There was a problem hiding this comment.
True. The other option is we just don't include a suggested replacement in the set-case (since I don't want people to set the main workspace or selected object themselves). I thought it would be better to include the get method so that people have a little bit of info, but if it's confusing I'm more than happy to remove it.
There was a problem hiding this comment.
Fair enough, I think you're right that the context is useful. Leaving as-is SGTM.
The basics
npm run formatandnpm run lintThe details
Resolves
Work on #5857
Proposed Changes
getSelectedtoBlocklymain.jsto point you to the accessors onBlockly.Behavior Before Change
No accessor
Behavior After Change
Accessor!
Reason for Changes
We don't really want external developers to have to use
common, since it was just used to break some circular dependencies.Test Coverage
N/A
Documentation
We probably have documentation that still points to
mainWorkspaceandselectedthat should be updated.Additional Information
Removal date is September 2022 so that we can remove
main.jsas soon as possible.