chore(generator): Format

One block protected with // prettier-ignore to preserve careful comment formatting. Where there are repeated concatenations prettier has made a pretty mess of things, but the correct fix is probably to use template literals instead (rather than just locally disabling prettier). This has been added to the to-do list in google#7600.
cpcallen · Oct 20, 2023 · 4be173d · 4be173d
1 parent a93dc78
commit 4be173d
Show file tree

Hide file tree

Showing 12 changed files with 775 additions and 510 deletions.
diff --git a/.prettierignore b/.prettierignore
@@ -18,7 +18,6 @@
 
 # Demos, scripts, misc
 /node_modules/*
-/generators/*
 /demos/*
 /appengine/*
 /externs/*
@@ -27,5 +26,5 @@
 CHANGELOG.md
 PULL_REQUEST_TEMPLATE.md
 
-# Don't bother formatting js blocks since we're getting rid of them
-/blocks/*.js
+# Don't bother formatting JavaScript files we're about to migrate:
+/generators/**/*.js
diff --git a/generators/javascript.ts b/generators/javascript.ts
@@ -33,8 +33,15 @@ export const javascriptGenerator = new JavascriptGenerator();
 
 // Install per-block-type generator functions:
 const generators: typeof javascriptGenerator.forBlock = {
-  ...colour, ...lists, ...logic, ...loops, ...math,
-  ...procedures, ...text, ...variables, ...variablesDynamic
+  ...colour,
+  ...lists,
+  ...logic,
+  ...loops,
+  ...math,
+  ...procedures,
+  ...text,
+  ...variables,
+  ...variablesDynamic,
 };
 for (const name in generators) {
   javascriptGenerator.forBlock[name] = generators[name];

diff --git a/generators/javascript/colour.ts b/generators/javascript/colour.ts
@@ -14,33 +14,44 @@ import type {Block} from '../../core/block.js';
 import type {JavascriptGenerator} from './javascript_generator.js';
 import {Order} from './javascript_generator.js';
 
-
-export function colour_picker(block: Block, generator: JavascriptGenerator): [string, Order] {
+export function colour_picker(
+  block: Block,
+  generator: JavascriptGenerator,
+): [string, Order] {
   // Colour picker.
   const code = generator.quote_(block.getFieldValue('COLOUR'));
   return [code, Order.ATOMIC];
-};
+}
 
-export function colour_random(block: Block, generator: JavascriptGenerator): [string, Order] {
+export function colour_random(
+  block: Block,
+  generator: JavascriptGenerator,
+): [string, Order] {
   // Generate a random colour.
-  const functionName = generator.provideFunction_('colourRandom', `
+  const functionName = generator.provideFunction_(
+    'colourRandom',
+    `
 function ${generator.FUNCTION_NAME_PLACEHOLDER_}() {
   var num = Math.floor(Math.random() * Math.pow(2, 24));
   return '#' + ('00000' + num.toString(16)).substr(-6);
 }
-`);
+`,
+  );
   const code = functionName + '()';
   return [code, Order.FUNCTION_CALL];
-};
+}
 
-export function colour_rgb(block: Block, generator: JavascriptGenerator): [string, Order] {
+export function colour_rgb(
+  block: Block,
+  generator: JavascriptGenerator,
+): [string, Order] {
   // Compose a colour from RGB components expressed as percentages.
   const red = generator.valueToCode(block, 'RED', Order.NONE) || 0;
-  const green =
-      generator.valueToCode(block, 'GREEN', Order.NONE) || 0;
-  const blue =
-      generator.valueToCode(block, 'BLUE', Order.NONE) || 0;
-  const functionName = generator.provideFunction_('colourRgb', `
+  const green = generator.valueToCode(block, 'GREEN', Order.NONE) || 0;
+  const blue = generator.valueToCode(block, 'BLUE', Order.NONE) || 0;
+  const functionName = generator.provideFunction_(
+    'colourRgb',
+    `
 function ${generator.FUNCTION_NAME_PLACEHOLDER_}(r, g, b) {
   r = Math.max(Math.min(Number(r), 100), 0) * 2.55;
   g = Math.max(Math.min(Number(g), 100), 0) * 2.55;
@@ -50,20 +61,23 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}(r, g, b) {
   b = ('0' + (Math.round(b) || 0).toString(16)).slice(-2);
   return '#' + r + g + b;
 }
-`);
+`,
+  );
   const code = functionName + '(' + red + ', ' + green + ', ' + blue + ')';
   return [code, Order.FUNCTION_CALL];
-};
+}
 
-export function colour_blend(block: Block, generator: JavascriptGenerator): [string, Order] {
+export function colour_blend(
+  block: Block,
+  generator: JavascriptGenerator,
+): [string, Order] {
   // Blend two colours together.
-  const c1 = generator.valueToCode(block, 'COLOUR1', Order.NONE) ||
-      "'#000000'";
-  const c2 = generator.valueToCode(block, 'COLOUR2', Order.NONE) ||
-      "'#000000'";
-  const ratio =
-      generator.valueToCode(block, 'RATIO', Order.NONE) || 0.5;
-  const functionName = generator.provideFunction_('colourBlend', `
+  const c1 = generator.valueToCode(block, 'COLOUR1', Order.NONE) || "'#000000'";
+  const c2 = generator.valueToCode(block, 'COLOUR2', Order.NONE) || "'#000000'";
+  const ratio = generator.valueToCode(block, 'RATIO', Order.NONE) || 0.5;
+  const functionName = generator.provideFunction_(
+    'colourBlend',
+    `
 function ${generator.FUNCTION_NAME_PLACEHOLDER_}(c1, c2, ratio) {
   ratio = Math.max(Math.min(Number(ratio), 1), 0);
   var r1 = parseInt(c1.substring(1, 3), 16);
@@ -80,7 +94,8 @@ function ${generator.FUNCTION_NAME_PLACEHOLDER_}(c1, c2, ratio) {
   b = ('0' + (b || 0).toString(16)).slice(-2);
   return '#' + r + g + b;
 }
-`);
+`,
+  );
   const code = functionName + '(' + c1 + ', ' + c2 + ', ' + ratio + ')';
   return [code, Order.FUNCTION_CALL];
-};
+}
diff --git a/generators/javascript/javascript_generator.ts b/generators/javascript/javascript_generator.ts
@@ -19,11 +19,11 @@ import {Names, NameType} from '../../core/names.js';
 import type {Workspace} from '../../core/workspace.js';
 import {inputTypes} from '../../core/inputs/input_types.js';
 
-
 /**
  * Order of operation ENUMs.
  * https://developer.mozilla.org/en/JavaScript/Reference/Operators/Operator_Precedence
  */
+// prettier-ignore
 export enum Order {
   ATOMIC = 0,            // 0 "" ...
   NEW = 1.1,             // new
@@ -60,7 +60,7 @@ export enum Order {
   YIELD = 17,            // yield
   COMMA = 18,            // ,
   NONE = 99,             // (...)
-};
+}
 
 /**
  * JavaScript code generator class.
@@ -93,7 +93,7 @@ export class JavascriptGenerator extends CodeGenerator {
     // a && (b && c) -> a && b && c
     [Order.LOGICAL_AND, Order.LOGICAL_AND],
     // a || (b || c) -> a || b || c
-    [Order.LOGICAL_OR, Order.LOGICAL_OR]
+    [Order.LOGICAL_OR, Order.LOGICAL_OR],
   ];
 
   /** @param name Name of language generator is for. */
@@ -126,8 +126,8 @@ export class JavascriptGenerator extends CodeGenerator {
     // this list is trivial.  This is intended to prevent users from
     // accidentally clobbering a built-in object or function.
     this.addReservedWords(
-        // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#Keywords
-        'break,case,catch,class,const,continue,debugger,default,delete,do,' +
+      // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Lexical_grammar#Keywords
+      'break,case,catch,class,const,continue,debugger,default,delete,do,' +
         'else,export,extends,finally,for,function,if,import,in,instanceof,' +
         'new,return,super,switch,this,throw,try,typeof,var,void,' +
         'while,with,yield,' +
@@ -139,7 +139,7 @@ export class JavascriptGenerator extends CodeGenerator {
         'arguments,' +
         // Everything in the current environment (835 items in Chrome,
         // 104 in Node).
-        Object.getOwnPropertyNames(globalThis).join(',')
+        Object.getOwnPropertyNames(globalThis).join(','),
     );
   }
 
@@ -166,14 +166,16 @@ export class JavascriptGenerator extends CodeGenerator {
     const devVarList = Variables.allDeveloperVariables(workspace);
     for (let i = 0; i < devVarList.length; i++) {
       defvars.push(
-          this.nameDB_.getName(devVarList[i], NameType.DEVELOPER_VARIABLE));
+        this.nameDB_.getName(devVarList[i], NameType.DEVELOPER_VARIABLE),
+      );
     }
 
     // Add user variables, but only ones that are being used.
     const variables = Variables.allUsedVarModels(workspace);
     for (let i = 0; i < variables.length; i++) {
       defvars.push(
-        this.nameDB_.getName(variables[i].getId(), NameType.VARIABLE));
+        this.nameDB_.getName(variables[i].getId(), NameType.VARIABLE),
+      );
     }
 
     // Declare all of the variables.
@@ -221,10 +223,11 @@ export class JavascriptGenerator extends CodeGenerator {
   quote_(string: string): string {
     // Can't use goog.string.quote since Google's style guide recommends
     // JS string literals use single quotes.
-    string = string.replace(/\\/g, '\\\\')
-        .replace(/\n/g, '\\\n')
-        .replace(/'/g, '\\\'');
-    return '\'' + string + '\'';
+    string = string
+      .replace(/\\/g, '\\\\')
+      .replace(/\n/g, '\\\n')
+      .replace(/'/g, "\\'");
+    return "'" + string + "'";
   }
 
   /**
@@ -237,7 +240,7 @@ export class JavascriptGenerator extends CodeGenerator {
     // Can't use goog.string.quote since Google's style guide recommends
     // JS string literals use single quotes.
     const lines = string.split(/\n/g).map(this.quote_);
-    return lines.join(' + \'\\n\' +\n');
+    return lines.join(" + '\\n' +\n");
   }
 
   /**
@@ -276,7 +279,7 @@ export class JavascriptGenerator extends CodeGenerator {
       }
     }
     const nextBlock =
-        block.nextConnection && block.nextConnection.targetBlock();
+      block.nextConnection && block.nextConnection.targetBlock();
     const nextCode = thisOnly ? '' : this.blockToCode(nextBlock);
     return commentCode + code + nextCode;
   }
@@ -293,7 +296,13 @@ export class JavascriptGenerator extends CodeGenerator {
    * @param order The highest order acting on this value.
    * @returns The adjusted value.
    */
-  getAdjusted(block: Block, atId: string, delta = 0, negate = false, order = Order.NONE): string|number {
+  getAdjusted(
+    block: Block,
+    atId: string,
+    delta = 0,
+    negate = false,
+    order = Order.NONE,
+  ): string | number {
     if (block.workspace.options.oneBasedIndex) {
       delta--;
     }