refactor(generators): Restructure generator modules to contain side effects (#7173)

* refactor(generators): Move lang.js -> lang/lang_gernator.js

  Move the LangGenerator definitions into their respective
  subdirectories and add a _generator suffix to their filenames,
  i.e. generators/javascript.js  becomes
  generators/javascript/javascript_generator.js.

  This is to keep related code together and allow the `lang/all.js`
  entrypoints to be moved to the top level generators/ directory.

  No goog module IDs were changed, so playground and test code
  that accesses this modules by filename does not need to be modified.

* refactor(generators) Move lang/all.js -> lang.js

  - Move the entrypoints in generators/*/all.js to correspondingly-named
    files in generators/ instead—i.e., generators/javascript/all.js
    becomes generators/javascript.js.

  - Update build_tasks.js accordingly.

* fix(generators): Add missing exports for LuaGenerator, PhpGenerator

  These were inadvertently omitted from #7161 and #7162, respectively.

* refactor(generators): Make block generator modules side-effect free

  - Move declaration of <lang>Generator instance from
    generators/<lang>/<lang>_generator.js to generators/<lang>.js.
  - Move .addReservedWords() calls from generators/<lang>/*.js to
    generators/<lang>.js
  - Modify generators/<lang>/*.js to export block generator functions
    individually, rather than installing on <lang>Generator instance.
  - Modify generators/<lang>.js to import and install block generator
    functions on <lang>Generator instance.

* fix(tests): Fix tests broken by restructuring of generators

  Where these tests needed block generator functions preinstalled
  they should have been importing the Blockly.<Lang>.all module.

  Where they do not need the provided block generator functions
  they can now create their own empty <Lang>Generator instances.

* chore: Update renamings file

  - Fix a malformation in previous entries that was not detected by
    the renaming file validator test.
  - Add entries describing the work done in this and related recent
    PRs.

* fix: Correct minor errors in PR #7173

  - Fix a search-and-replace error in renamings.json5
  - Fix an incorrect-but-usable import in generator_test.js
This commit is contained in:
Christopher Allen
2023-06-20 23:22:44 +01:00
committed by GitHub
parent 021a560ef0
commit 130989763c
64 changed files with 2120 additions and 2046 deletions

View File

@@ -13,10 +13,10 @@ goog.declareModuleId('Blockly.PHP.loops');
import * as stringUtils from '../../core/utils/string.js';
import {NameType} from '../../core/names.js';
import {phpGenerator, Order} from '../php.js';
import {Order} from './php_generator.js';
phpGenerator.forBlock['controls_repeat_ext'] = function(block, generator) {
export function controls_repeat_ext(block, generator) {
// Repeat n times.
let repeats;
if (block.getField('TIMES')) {
@@ -42,10 +42,9 @@ phpGenerator.forBlock['controls_repeat_ext'] = function(block, generator) {
return code;
};
phpGenerator.forBlock['controls_repeat'] =
phpGenerator.forBlock['controls_repeat_ext'];
export const controls_repeat = controls_repeat_ext;
phpGenerator.forBlock['controls_whileUntil'] = function(block, generator) {
export function controls_whileUntil(block, generator) {
// Do while/until loop.
const until = block.getFieldValue('MODE') === 'UNTIL';
let argument0 =
@@ -60,7 +59,7 @@ phpGenerator.forBlock['controls_whileUntil'] = function(block, generator) {
return 'while (' + argument0 + ') {\n' + branch + '}\n';
};
phpGenerator.forBlock['controls_for'] = function(block, generator) {
export function controls_for(block, generator) {
// For loop.
const variable0 =
generator.nameDB_.getName(block.getFieldValue('VAR'), NameType.VARIABLE);
@@ -125,7 +124,7 @@ phpGenerator.forBlock['controls_for'] = function(block, generator) {
return code;
};
phpGenerator.forBlock['controls_forEach'] = function(block, generator) {
export function controls_forEach(block, generator) {
// For each loop.
const variable0 =
generator.nameDB_.getName(
@@ -140,7 +139,7 @@ phpGenerator.forBlock['controls_forEach'] = function(block, generator) {
return code;
};
phpGenerator.forBlock['controls_flow_statements'] = function(block, generator) {
export function controls_flow_statements(block, generator) {
// Flow statements: continue, break.
let xfix = '';
if (generator.STATEMENT_PREFIX) {