feat(scratch): Add scaffolding ArduinoScratch extension (#1)

* Add initial configuration and tasks for Scratch Arduino integration

* Remove redundant cleanup command from scratch:init task and comment out formatMessage import in Arduino extension

* Refactor task names in Taskfile.yaml for consistency and update Scratch3Arduino class to include example block and clean up imports

* Update Scratch3Arduino block opcode and remove commented-out code in patch-gui.js

Author: dido18

.gitignore

@@ -0,0 +1 @@
+scratch-editor

Taskfile.yaml

@@ -0,0 +1,19 @@
+version: "3"
+vars:
+  SCRATCH_EDITOR_VERSION: v12.0.1
+
+tasks:
+  scratch:init:
+    - git clone --depth 1 --branch {{ .SCRATCH_EDITOR_VERSION }}  https://github.com/scratchfoundation/scratch-editor.git
+    - cd scratch-editor && npm install && npm run build
+    - cd scratch-editor/packages/scratch-gui && npm install
+    - cd scratch-editor/packages/scratch-vm && npm install
+
+  scratch:patch:
+    - cd scratch-editor/packages/scratch-gui && node ../../../scratch-arduino-extensions/scripts/patch-gui.js
+
+  scratch:start:
+    - cd scratch-editor/packages/scratch-gui  && npm start
+
+  scratch:clean:
+    - rm -rf scratch-editor

scratch-arduino-extensions/packages/scratch-vm/src/extensions/scratch3_arduino/index.js

@@ -0,0 +1,46 @@
+// Option 1: Relative path to cousin folder
+// const formatMessage = require('../../../../../../scratch-editor/node_modules/format-message');
+const BlockType = require('../../../../../../scratch-editor/packages/scratch-vm/src/extension-support/block-type');
+
+/**
+ * Url of icon to be displayed at the left edge of each extension block.
+ * @type {string}
+ */
+// eslint-disable-next-line max-len
+const iconURI = ''; 
+
+/**
+ * Url of icon to be displayed in the toolbox menu for the extension category.
+ * @type {string}
+ */
+// eslint-disable-next-line max-len
+const menuIconURI =  ''
+
+class Scratch3Arduino {
+    constructor (runtime) {
+        this.runtime = runtime;
+   }
+};
+
+Scratch3Arduino.prototype.getInfo = function () {
+        return {
+            id: 'arduino',
+            name: "Arduino",
+            menuIconURI: menuIconURI,
+            blockIconURI: iconURI,
+            blocks: [ 
+                {
+                    opcode: 'noop',
+                    blockType: BlockType.COMMAND,
+                    text: 'do nothing',
+                    func: 'noop'
+                },
+            ],
+        
+        };
+}
+
+Scratch3Arduino.prototype.noop = function () {
+};
+
+module.exports = Scratch3Arduino;

scratch-arduino-extensions/scripts/patch-gui.js

@@ -0,0 +1,67 @@
+const path = require("path");
+const fs = require("fs");
+
+const BaseDir = path.resolve(__dirname, "../"); // base dir is the 'scratch-arduino-extensions'
+
+const ScratchVmExtensionsManagerFile = path.resolve(
+  BaseDir,
+  "../scratch-editor/packages/scratch-vm/src/extension-support/extension-manager.js"
+);
+
+const ScratchVmVirtualMachineFile = path.resolve(
+  BaseDir,
+  "../scratch-editor/packages/scratch-vm/src/virtual-machine.js",
+);
+
+const ExtIds = ["Scratch3Arduino"];
+const ExtDirName = "scratch3_arduino";
+
+const PatchedExtensionDir = path.resolve(
+  BaseDir,
+  "./packages/scratch-vm/src/extensions/",
+  ExtDirName,
+);
+const ScratchVmExtensionsDir = path.resolve(
+  BaseDir,
+  "../scratch-editor/packages/scratch-vm/src/extensions",
+   ExtDirName,
+);
+
+if (!fs.existsSync(ScratchVmExtensionsDir)) {
+  fs.symlinkSync(PatchedExtensionDir, ScratchVmExtensionsDir, "dir");
+  console.log("Set symbolic link to", ScratchVmExtensionsDir);
+} else {
+  console.log("Symbolic link already set to", ScratchVmExtensionsDir);
+}
+
+let managerCode = fs.readFileSync(ScratchVmExtensionsManagerFile, "utf-8");
+for (const ExtId of ExtIds) {
+  if (managerCode.includes(ExtId)) {
+    console.log(`Already registered in manager: ${ExtId}`);
+  } else {
+    fs.copyFileSync(ScratchVmExtensionsManagerFile, `${ScratchVmExtensionsManagerFile}.orig`);
+    managerCode = managerCode.replace(
+      /builtinExtensions = {[\s\S]*?};/,
+      `$&\n\nbuiltinExtensions.${ExtId} = () => require('../extensions/${ExtDirName}');`,
+    );
+    fs.writeFileSync(ScratchVmExtensionsManagerFile, managerCode);
+    console.log(`Registered in manager: ${ExtId}`);
+  }
+}
+
+
+// Add the extension as a core extension.
+let vmCode = fs.readFileSync(ScratchVmVirtualMachineFile, "utf-8");
+for (const ExtId of ExtIds) {
+  if (vmCode.includes(ExtId)) {
+    console.log(`Already added as a core extension: ${ExtId}`);
+  } else {
+    fs.copyFileSync(ScratchVmVirtualMachineFile, `${ScratchVmVirtualMachineFile}.orig`);
+    vmCode = vmCode.replace(
+      /CORE_EXTENSIONS = \[[\s\S]*?\];/,
+      `$&\n\nCORE_EXTENSIONS.push('${ExtId}');`,
+    );
+    fs.writeFileSync(ScratchVmVirtualMachineFile, vmCode);
+    console.log(`Add as a core extension: ${ExtId}`);
+  }
+}