refactor: add and use explicit field registration methods (#172)

* refactor: add and use explicit field registration methods

* chore: add comment to field registration methods

Author: gonfunko

src/fields/field_angle.js

@@ -423,4 +423,9 @@ class FieldAngle extends Blockly.FieldNumber {
   }
 }
 
-Blockly.fieldRegistry.register("field_angle", FieldAngle);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldAngle() {
+  Blockly.fieldRegistry.register("field_angle", FieldAngle);
+}

src/fields/field_colour_slider.js

@@ -380,4 +380,9 @@ export class FieldColourSlider extends FieldColour {
   }
 }
 
-Blockly.fieldRegistry.register("field_colour_slider", FieldColourSlider);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldColourSlider() {
+  Blockly.fieldRegistry.register("field_colour_slider", FieldColourSlider);
+}

src/fields/field_dropdown.js

@@ -33,5 +33,10 @@ class FieldDropdown extends Blockly.FieldDropdown {
   }
 }
 
-Blockly.fieldRegistry.unregister("field_dropdown");
-Blockly.fieldRegistry.register("field_dropdown", FieldDropdown);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldDropdown() {
+  Blockly.fieldRegistry.unregister("field_dropdown");
+  Blockly.fieldRegistry.register("field_dropdown", FieldDropdown);
+}

src/fields/field_matrix.js

@@ -31,7 +31,7 @@ import * as Blockly from "blockly/core";
  * @extends {Blockly.Field}
  * @constructor
  */
-export class FieldMatrix extends Blockly.Field {
+class FieldMatrix extends Blockly.Field {
   originalStyle;
 
   constructor(matrix) {
@@ -626,4 +626,9 @@ export class FieldMatrix extends Blockly.Field {
   }
 }
 
-Blockly.fieldRegistry.register("field_matrix", FieldMatrix);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldMatrix() {
+  Blockly.fieldRegistry.register("field_matrix", FieldMatrix);
+}

src/fields/field_note.js

@@ -929,4 +929,9 @@ export class FieldNote extends Blockly.FieldTextInput {
   }
 }
 
-Blockly.fieldRegistry.register("field_note", FieldNote);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldNote() {
+  Blockly.fieldRegistry.register("field_note", FieldNote);
+}

src/fields/field_number.js

@@ -371,5 +371,10 @@ class FieldNumberPicker extends Blockly.FieldNumber {
 
 FieldNumberPicker.prototype.DEFAULT_VALUE = "";
 
-Blockly.fieldRegistry.unregister("field_number");
-Blockly.fieldRegistry.register("field_number", FieldNumberPicker);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldNumber() {
+  Blockly.fieldRegistry.unregister("field_number");
+  Blockly.fieldRegistry.register("field_number", FieldNumberPicker);
+}

src/fields/field_textinput_removable.js

@@ -93,7 +93,12 @@ export class FieldTextInputRemovable extends Blockly.FieldTextInput {
   }
 }
 
-Blockly.fieldRegistry.register(
-  "field_input_removable",
-  FieldTextInputRemovable
-);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldTextInputRemovable() {
+  Blockly.fieldRegistry.register(
+    "field_input_removable",
+    FieldTextInputRemovable
+  );
+}

src/fields/field_variable.js

@@ -162,5 +162,10 @@ class FieldVariable extends Blockly.FieldVariable {
   }
 }
 
-Blockly.fieldRegistry.unregister("field_variable");
-Blockly.fieldRegistry.register("field_variable", FieldVariable);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldVariable() {
+  Blockly.fieldRegistry.unregister("field_variable");
+  Blockly.fieldRegistry.register("field_variable", FieldVariable);
+}

src/fields/field_variable_getter.js

@@ -29,7 +29,7 @@ import * as Blockly from "blockly/core";
  * Class for a variable getter field.
  * @param {string} allowedVariableType The type of variables this field can display.
  */
-export class FieldVariableGetter extends Blockly.FieldLabel {
+class FieldVariableGetter extends Blockly.FieldLabel {
   constructor(allowedVariableType = "") {
     super(Blockly.Field.SKIP_SETUP);
     this.SERIALIZABLE = true;
@@ -101,4 +101,9 @@ export class FieldVariableGetter extends Blockly.FieldLabel {
   }
 }
 
-Blockly.fieldRegistry.register("field_variable_getter", FieldVariableGetter);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldVariableGetter() {
+  Blockly.fieldRegistry.register("field_variable_getter", FieldVariableGetter);
+}

src/fields/field_vertical_separator.js

@@ -128,7 +128,12 @@ class FieldVerticalSeparator extends Blockly.Field {
   }
 }
 
-Blockly.fieldRegistry.register(
-  "field_vertical_separator",
-  FieldVerticalSeparator
-);
+/**
+ * Register the field and any dependencies.
+ */
+export function registerFieldVerticalSeparator() {
+  Blockly.fieldRegistry.register(
+    "field_vertical_separator",
+    FieldVerticalSeparator
+  );
+}

src/index.js

@@ -23,7 +23,6 @@ import "./blocks/sound.js";
 import * as scratchBlocksUtils from "./scratch_blocks_utils.js";
 import * as ScratchVariables from "./variables.js";
 import "./css.js";
-import "./fields/field_vertical_separator.js";
 import "./renderer/renderer.js";
 import * as contextMenuItems from "./context_menu_items.js";
 import {
@@ -47,29 +46,46 @@ import "./events/events_block_comment_delete.js";
 import "./events/events_block_comment_move.js";
 import "./events/events_block_comment_resize.js";
 import "./events/events_scratch_variable_create.js";
-import "./fields/field_dropdown.js";
-import "./fields/field_variable.js";
-import "./fields/field_variable_getter.js";
 import { buildShadowFilter } from "./shadows.js";
+import { registerFieldAngle } from "./fields/field_angle.js";
+import {
+  registerFieldColourSlider,
+  FieldColourSlider,
+} from "./fields/field_colour_slider.js";
+import { registerFieldDropdown } from "./fields/field_dropdown.js";
+import { registerFieldMatrix } from "./fields/field_matrix.js";
+import { registerFieldNote, FieldNote } from "./fields/field_note.js";
+import { registerFieldNumber } from "./fields/field_number.js";
+import { registerFieldTextInputRemovable } from "./fields/field_textinput_removable.js";
+import { registerFieldVariableGetter } from "./fields/field_variable_getter.js";
+import { registerFieldVariable } from "./fields/field_variable.js";
+import { registerFieldVerticalSeparator } from "./fields/field_vertical_separator.js";
 
 export * from "blockly/core";
 export * from "./block_reporting.js";
 export * from "./categories.js";
 export * from "./procedures.js";
-export * from "./fields/field_angle.js";
-export * from "./fields/field_colour_slider.js";
-export * from "./fields/field_matrix.js";
-export * from "./fields/field_note.js";
-export * from "./fields/field_number.js";
 export * from "../msg/scratch_msgs.js";
 export * from "./constants.js";
 export { glowStack };
 export { scratchBlocksUtils };
 export { CheckableContinuousFlyout };
 export { ScratchVariables };
 export { contextMenuItems };
+export { FieldColourSlider, FieldNote };
 
 export function inject(container, options) {
+  registerFieldAngle();
+  registerFieldColourSlider();
+  registerFieldDropdown();
+  registerFieldMatrix();
+  registerFieldNote();
+  registerFieldNumber();
+  registerFieldTextInputRemovable();
+  registerFieldVariableGetter();
+  registerFieldVariable();
+  registerFieldVerticalSeparator();
+
   Object.assign(options, {
     renderer: "scratch",
     plugins: {