8000 refactor(generators): Introduce `DartGenerator` class, `Order` enum by cpcallen · Pull Request #7160 · google/blockly · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

refactor(generators): Introduce DartGenerator class, Order enum #7160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jun 13, 2023
Merged

refactor(generators): Introduce DartGenerator class, Order enum #7160

merged 3 commits into from
Jun 13, 2023

Conversation

cpcallen
Copy link
Contributor
@cpcallen cpcallen commented Jun 13, 2023 •
edited
Loading

The basics

  • I branched from develop
  • My pull request is against develop
  • My code follows the style guide
  • I ran npm run format and npm run lint

The details

Resolves

Part of #7085.

Proposed Changes

Introduce a DartGenerator class to be the class of which dartGenerator is an instance (without any additional properties making it a singleton).
Introduce an Order enum (for now Closure-style) for the operator precedence table.
Don't rename dartGenerator to Dart in generators/dart/*.js.

Behaviour Before/After Change

There should be no changes in behaviour.

Reason for Changes

See #7085.

Test Coverage

Passes npm test; no changes to manual testing anticipated.

Documentation

Documentation for the DartGenerator class and Order enum should be automatically generated by our JSDoc configs.

Additional Information

It is now possible to create multiple dartGenerator objects, which can share (or not share) block generator implementations. Note that new instances do not by default come with any generator functions pre-installed.

import {dartGenerator, DartGenerator} from 'blockly/dart';

const customJSGenerator = new DartGenerator();

// Optionally copy standard generator functions to new instance:
Object.assign(customDartGenerator.forBlock, dartGenerator.forBlock);

// Optionally add/replace some/all generator functions:
customDartGenerator.forBlock('block_type') = function(block) {/* new implementation */};

// Optionally change settings:
customDartGenerator.INDENT = '\t';  // Use tabs to indent generated code.

We now provide an enum of the operator precedence values (order of operations) constants as a separate export:

import {dartGenerator, Order} from 'blockly/dart';

// Old:
dartGenerator.forBlock('answer_expression_block') = function(block) {
  const code = '42';
  return [code, dartGenerator.ORDER_ATOMIC]
}

// New:
dartGenerator.forBlock('answer_expression_block') = function(block) {
  const code = '42';
  return [code, Order.ATOMIC]
}

DEPRECATION: The .ORDER_* constants on dartGenerator are deprecated; they still exist but are no longer part of the documented API and will be removed in a future version of Blockly. We recommend that you update your custom generator code to use the Order enum at your earliest convenience.

@cpcallen cpcallen requested a review from a team as a code owner June 13, 2023 23:18
@cpcallen cpcallen requested a review from BeksOmega June 13, 2023 23:18
@cpcallen cpcallen changed the title refactor(generators): Introduce JavascriptGenerator class, Order enum refactor(generators): Introduce DartGenerator class, Order enum Jun 13, 2023
@cpcallen cpcallen merged commit 2690165 into google:develop Jun 13, 2023
@cpcallen cpcallen deleted the refactor/7085/dart branch June 14, 2023 02:52
@cpcallen cpcallen added the deprecation This PR deprecates an API. label Jun 14, 2023
@github-actions github-actions bot added PR: refactor and removed PR: refactor deprecation This PR deprecates an API. labels Jun 14, 2023
cpcallen added a commit to cpcallen/blockly that referenced this pull request Jun 14, 2023
@cpcallen
chore(generators): Fix nits
fccdd41 
Addresses various nits that escaped previous PRs:

* Add TSDoc for `BlockGenerator` in `core/generator.ts` for PR google#7150.
* Fix bad formating in `generators/javascript.js` from PR google#7153.
* Add missing `@enum` tag that should have been included in PR google#7160.
* Delete obsolete comment from `generators/python.js` for PR google#7163.
@cpcallen cpcallen mentioned this pull request Jun 14, 2023
Merged
4 tasks
cpcallen added a commit that referenced this pull request Jun 14, 2023
@cpcallen
chore(generators): Fix nits (#7166)
12b91ae 
Addresses various nits that escaped previous PRs:

* Add TSDoc for `BlockGenerator` in `core/generator.ts` for PR #7150.
* Fix bad formating in `generators/javascript.js` from PR #7153.
* Add missing `@enum` tag that should have been included in PR #7160.
* Delete obsolete comment from `generators/python.js` for PR #7163.
@cpcallen cpcallen linked an issue Jun 14, 2023 that may be closed by this pull request
Proposal: Per-language subclasses of CodeGenerator in generators/ #7085
Closed
@cpcallen cpcallen added the deprecation This PR deprecates an API. label Jun 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BeksOmega BeksOmega BeksOmega approved these changes

Assignees

@BeksOmega BeksOmega

Labels
component: generators deprecation This PR deprecates an API. PR: refactor
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Proposal: Per-language subclasses of CodeGenerator in generators/
2 participants
@cpcallen @BeksOmega
0