fix: Rename Generator to CodeGenerator #6585
Conversation
Stops collisions with ES6's Generator. The old Blockly.Generator still exists as a name, but is now deprecated.
|
Drive-by comment: We could enable a tslint rule that yells at us when we're shadowing variables. There is an option you have to pass to have it yell about global objects. Additional drive-by comment: We do have a codelab about generators. |
|
We aren't actually shadowing anything. Generator (ES6) is indeed an object, but not one that exists in the global namespace. One can't execute However, TypeScript has this fantasy that 'Generator' is a global object, and gets all confused when it sees a user-created object of that name. So we're actually seeing two separate issues with TypeScript here: 1) it should be able to keep track of what Blockly's Generator object is, and 2) it shouldn't even need to keep track of anything since there's no conflict. |
The basics
npm run formatandnpm run lintThe details
Resolves
Naming collision between Blockly.Generator and ES6's Generator.
Proposed Changes
Rename our Generator to CodeGenerator (it's a more descriptive name anyway).
Behaviour Before Change
TypeScript would get confused think that our code generators only had .next .return and .throw methods.
Behaviour After Change
TypeScript should be less grumpy.
Reason for Changes
TypeScript is pretending to be Java.
Test Coverage
I left the tests unchanged after the rename to verify that the old name still works. Then I updated the tests to the new name.
Documentation
We currently don't have any documentation about creating a new CodeGenerator. This is a separate issue.
Additional Information
In a separate commit on this PR I stripped out all the trailing whitespace from our codebase.