refactor: migrate scratch-blocks to Typescript

src/block_reporting.js → src/block_reporting.ts

@@ -1,10 +1,12 @@
 import * as Blockly from "blockly/core";
-import { Colours } from "./colours.js";
+import { Colours } from "./colours";
 
-export function reportValue(id, value) {
-  const block =
-    Blockly.getMainWorkspace().getBlockById(id) ||
-    Blockly.getMainWorkspace().getFlyout().getWorkspace().getBlockById(id);
+export function reportValue(id: string, value: string) {
+  const block = (Blockly.getMainWorkspace().getBlockById(id) ||
+    (Blockly.getMainWorkspace() as Blockly.WorkspaceSvg)
+      .getFlyout()
+      .getWorkspace()
+      .getBlockById(id)) as Blockly.BlockSvg;
   if (!block) {
     throw "Tried to report value on block that does not exist.";
   }

src/blocks/colour.js → src/blocks/colour.ts

@@ -23,23 +23,23 @@
  * @author [email protected] (Neil Fraser)
  */
 import * as Blockly from "blockly/core";
-import * as Constants from "../constants.js";
+import * as Constants from "../constants";
 
 /**
  * Pick a random colour.
- * @return {string} #RRGGBB for random colour.
+ *
+ * @returns #RRGGBB for random colour.
  */
-function randomColour() {
-  var num = Math.floor(Math.random() * Math.pow(2, 24));
+function randomColour(): string {
+  const num = Math.floor(Math.random() * Math.pow(2, 24));
   return "#" + ("00000" + num.toString(16)).substr(-6);
 }
 
 Blockly.Blocks["colour_picker"] = {
   /**
    * Block for colour picker.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: "%1",
       args0: [

src/blocks/control.js → src/blocks/control.ts

@@ -19,15 +19,13 @@
  */
 
 import * as Blockly from "blockly/core";
-import { Categories } from "../categories.js";
 
 Blockly.Blocks["control_forever"] = {
   /**
    * Block for repeat n times (external number).
    * https://blockly-demo.appspot.com/static/demos/blockfactory/index.html#5eke39
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     const ws = this.workspace.options.parentWorkspace || this.workspace;
     this.jsonInit({
       id: "control_forever",
@@ -51,7 +49,6 @@ Blockly.Blocks["control_forever"] = {
           flip_rtl: true,
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_end"],
     });
   },
@@ -61,9 +58,8 @@ Blockly.Blocks["control_repeat"] = {
   /**
    * Block for repeat n times (external number).
    * https://blockly-demo.appspot.com/static/demos/blockfactory/index.html#so57n9
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     const ws = this.workspace.options.parentWorkspace || this.workspace;
     this.jsonInit({
       id: "control_repeat",
@@ -93,7 +89,6 @@ Blockly.Blocks["control_repeat"] = {
           flip_rtl: true,
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -102,9 +97,8 @@ Blockly.Blocks["control_repeat"] = {
 Blockly.Blocks["control_if"] = {
   /**
    * Block for if-then.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       type: "control_if",
       message0: Blockly.Msg.CONTROL_IF,
@@ -122,7 +116,6 @@ Blockly.Blocks["control_if"] = {
           name: "SUBSTACK",
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -131,9 +124,8 @@ Blockly.Blocks["control_if"] = {
 Blockly.Blocks["control_if_else"] = {
   /**
    * Block for if-else.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       type: "control_if_else",
       message0: Blockly.Msg.CONTROL_IF,
@@ -159,7 +151,6 @@ Blockly.Blocks["control_if_else"] = {
           name: "SUBSTACK2",
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -168,13 +159,12 @@ Blockly.Blocks["control_if_else"] = {
 Blockly.Blocks["control_stop"] = {
   /**
    * Block for stop all scripts.
-   * @this Blockly.Block
    */
-  init: function () {
-    var ALL_SCRIPTS = "all";
-    var THIS_SCRIPT = "this script";
-    var OTHER_SCRIPTS = "other scripts in sprite";
-    var stopDropdown = new Blockly.FieldDropdown(
+  init: function (this: Blockly.Block) {
+    const ALL_SCRIPTS = "all";
+    const THIS_SCRIPT = "this script";
+    const OTHER_SCRIPTS = "other scripts in sprite";
+    const stopDropdown = new Blockly.FieldDropdown(
       function () {
         if (
           this.sourceBlock_ &&
@@ -205,9 +195,8 @@ Blockly.Blocks["control_stop"] = {
 Blockly.Blocks["control_wait"] = {
   /**
    * Block to wait (pause) stack.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       id: "control_wait",
       message0: Blockly.Msg.CONTROL_WAIT,
@@ -217,7 +206,6 @@ Blockly.Blocks["control_wait"] = {
           name: "DURATION",
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -226,9 +214,8 @@ Blockly.Blocks["control_wait"] = {
 Blockly.Blocks["control_wait_until"] = {
   /**
    * Block to wait until a condition becomes true.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.CONTROL_WAITUNTIL,
       args0: [
@@ -238,7 +225,6 @@ Blockly.Blocks["control_wait_until"] = {
           check: "Boolean",
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -247,9 +233,8 @@ Blockly.Blocks["control_wait_until"] = {
 Blockly.Blocks["control_repeat_until"] = {
   /**
    * Block to repeat until a condition becomes true.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     const ws = this.workspace.options.parentWorkspace || this.workspace;
     this.jsonInit({
       message0: Blockly.Msg.CONTROL_REPEATUNTIL,
@@ -279,7 +264,6 @@ Blockly.Blocks["control_repeat_until"] = {
           flip_rtl: true,
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -290,7 +274,7 @@ Blockly.Blocks["control_while"] = {
    * Block to repeat until a condition becomes false.
    * (This is an obsolete "hacked" block, for compatibility with 2.0.)
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     const ws = this.workspace.options.parentWorkspace || this.workspace;
     this.jsonInit({
       message0: Blockly.Msg.CONTROL_WHILE,
@@ -320,7 +304,6 @@ Blockly.Blocks["control_while"] = {
           flip_rtl: true,
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -330,9 +313,8 @@ Blockly.Blocks["control_for_each"] = {
   /**
    * Block for for-each. This is an obsolete block that is implemented for
    * compatibility with Scratch 2.0 projects.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       type: "control_for_each",
       message0: Blockly.Msg.CONTROL_FOREACH,
@@ -353,7 +335,6 @@ Blockly.Blocks["control_for_each"] = {
           name: "SUBSTACK",
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -362,14 +343,12 @@ Blockly.Blocks["control_for_each"] = {
 Blockly.Blocks["control_start_as_clone"] = {
   /**
    * Block for "when I start as a clone" hat.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       id: "control_start_as_clone",
       message0: Blockly.Msg.CONTROL_STARTASCLONE,
       args0: [],
-      category: Categories.control,
       extensions: ["colours_control", "shape_hat"],
     });
   },
@@ -383,9 +362,8 @@ Blockly.Blocks["control_create_clone_of_menu"] = {};
 Blockly.Blocks["control_create_clone_of"] = {
   /**
    * Block for "create clone of..."
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       id: "control_start_as_clone",
       message0: Blockly.Msg.CONTROL_CREATECLONEOF,
@@ -395,7 +373,6 @@ Blockly.Blocks["control_create_clone_of"] = {
           name: "CLONE_OPTION",
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -404,13 +381,11 @@ Blockly.Blocks["control_create_clone_of"] = {
 Blockly.Blocks["control_delete_this_clone"] = {
   /**
    * Block for "delete this clone."
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.CONTROL_DELETETHISCLONE,
       args0: [],
-      category: Categories.control,
       extensions: ["colours_control", "shape_end"],
     });
   },
@@ -420,12 +395,10 @@ Blockly.Blocks["control_get_counter"] = {
   /**
    * Block to get the counter value. This is an obsolete block that is
    * implemented for compatibility with Scratch 2.0 projects.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.CONTROL_COUNTER,
-      category: Categories.control,
       extensions: ["colours_control", "output_number"],
     });
   },
@@ -435,12 +408,10 @@ Blockly.Blocks["control_incr_counter"] = {
   /**
    * Block to add one to the counter value. This is an obsolete block that is
    * implemented for compatibility with Scratch 2.0 projects.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.CONTROL_INCRCOUNTER,
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -450,12 +421,10 @@ Blockly.Blocks["control_clear_counter"] = {
   /**
    * Block to clear the counter value. This is an obsolete block that is
    * implemented for compatibility with Scratch 2.0 projects.
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.CONTROL_CLEARCOUNTER,
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },
@@ -473,9 +442,8 @@ Blockly.Blocks["control_all_at_once"] = {
    * reporter that is always true (e.g. "if 1 = 1"). Also note that the
    * Scratch 2.0 spec for this block is "warpSpeed", but the label shows
    * "all at once".
-   * @this Blockly.Block
    */
-  init: function () {
+  init: function (this: Blockly.Block) {
     this.jsonInit({
       message0: Blockly.Msg.CONTROL_ALLATONCE,
       message1: "%1", // Statement
@@ -485,7 +453,6 @@ Blockly.Blocks["control_all_at_once"] = {
           name: "SUBSTACK",
         },
       ],
-      category: Categories.control,
       extensions: ["colours_control", "shape_statement"],
     });
   },