Merge pull request #180 from sugarlabs/editor-yaml

Editor: Use YAML to represent instructions

Author: meganindya

package-lock.json

@@ -22,6 +22,7 @@
     "@types/jest": "^27.4.0",
     "@types/jquery": "^3.5.8",
     "@types/jqueryui": "^1.12.16",
+    "@types/js-yaml": "^4.0.5",
     "@types/node": "^16.11.21",
     "@types/p5": "^1.3.3",
     "@types/react": "^17.0.38",
@@ -47,6 +48,7 @@
   "dependencies": {
     "@sugarlabs/musicblocks-v4-lib": "^0.2.0",
     "jquery": "^3.6.0",
+    "js-yaml": "^3.14.1",
     "p5": "^1.4.0",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",

package.json

@@ -0,0 +1,18 @@
+/** Reresents a literal code argument. */
+export type ICodeArgumentLiteral = boolean | number | string;
+
+/** Represents the interface for a code argument snapshot object. */
+export interface ICodeArgumentObj {
+    [key: string]: ICodeArgumentLiteral | ICodeArgumentObj;
+}
+
+/** Represents the interface for a code argument element. */
+export type ICodeArgument = ICodeArgumentLiteral | ICodeArgumentObj;
+
+/** Represents the interface for a code instruction element object. */
+export interface ICodeInstructionObj {
+    [instruction: string]: ICodeArgument;
+}
+
+/** Represents the interface for a code instruction element. */
+export type ICodeInstruction = string | ICodeInstructionObj;

src/components/editor/@types/index.ts

@@ -0,0 +1,30 @@
+abstract class SyntaxError extends Error {
+    private _name: string;
+    private _message: string;
+
+    constructor(name: string, message: string) {
+        super(message);
+        this._name = name;
+        this._message = message;
+    }
+
+    public toString(): string {
+        return `${this._name}: ${this._message}`;
+    }
+
+    public get type(): string {
+        return this._name;
+    }
+}
+
+export class InvalidInstructionError extends SyntaxError {
+    constructor(message: string) {
+        super('InvalidInstructionError', message);
+    }
+}
+
+export class InvalidArgumentError extends SyntaxError {
+    constructor(message: string) {
+        super('InvalidArgumentError', message);
+    }
+}