Lint and format js/js-export/

* js/js-export files * JS export API files * Reorganize comments Co-authored-by: Anindya Kundu <[email protected]>
sugarlabs · Feb 5, 2021 · c116364 · c116364
1 parent 55051a7
commit c116364
Show file tree

Hide file tree

Showing 17 changed files with 105 additions and 33 deletions.
diff --git a/js/js-export/API/DictBlocksAPI.js b/js/js-export/API/DictBlocksAPI.js
@@ -15,6 +15,10 @@
  * MA 02110-1335 USA.
  */
 
+/* global turtles, JSInterface */
+
+/* exported DictBlocksAPI */
+
 /**
  * Class pertaining to the API methods specific to Dictionary blocks for JavaScript based Music Blocks
  * programs.

diff --git a/js/js-export/API/DrumBlocksAPI.js b/js/js-export/API/DrumBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global MusicBlocks, JSInterface */
+
+/* exported DrumBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Drum blocks for JavaScript based Music Blocks

diff --git a/js/js-export/API/GraphicsBlocksAPI.js b/js/js-export/API/GraphicsBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global JSInterface */
+
+/* exported GraphicsBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Graphics blocks for JavaScript based Music Blocks

diff --git a/js/js-export/API/IntervalsBlocksAPI.js b/js/js-export/API/IntervalsBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global JSInterface, MusicBlocks */
+
+/* exported IntervalsBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Intervals blocks for JavaScript based Music Blocks

diff --git a/js/js-export/API/MeterBlocksAPI.js b/js/js-export/API/MeterBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global JSInterface, Singer */
+
+/* exported MeterBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Meter blocks for JavaScript based Music Blocks

diff --git a/js/js-export/API/OrnamentBlocksAPI.js b/js/js-export/API/OrnamentBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global JSInterface, MusicBlocks */
+
+/* exported OrnamentBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Ornament blocks for JavaScript based Music Blocks

diff --git a/js/js-export/API/PenBlocksAPI.js b/js/js-export/API/PenBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global JSInterface, turtles, logo */
+
+/* exported PenBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Pen blocks for JavaScript based Music Blocks

diff --git a/js/js-export/API/PitchBlocksAPI.js b/js/js-export/API/PitchBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global JSInterface, MusicBlocks, Singer */
+
+/* exported PitchBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Pitch blocks for JavaScript based Music Blocks
@@ -35,9 +39,12 @@ class PitchBlocksAPI {
 
     playNthModalPitch(number, octave) {
         const args = JSInterface.validateArgs("playNthModalPitch", [number, octave]);
-        return this.runCommand(
-            "playNthModalPitch", [args[0], args[1], this.turIndex, MusicBlocks.BLK]
-        );
+        return this.runCommand("playNthModalPitch", [
+            args[0],
+            args[1],
+            this.turIndex,
+            MusicBlocks.BLK
+        ]);
     }
 
     playPitchNumber(number) {

diff --git a/js/js-export/API/RhythmBlocksAPI.js b/js/js-export/API/RhythmBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global JSInterface, MusicBlocks */
+
+/* exported RhythmBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Rhythm blocks for JavaScript based Music Blocks

diff --git a/js/js-export/API/ToneBlocksAPI.js b/js/js-export/API/ToneBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global JSInterface, MusicBlocks */
+
+/* exported ToneBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Tone blocks for JavaScript based Music Blocks
@@ -38,7 +42,12 @@ class ToneBlocksAPI {
     }
 
     async doChorus(chorusRate, delayTime, chorusDepth, flow) {
-        const args = JSInterface.validateArgs("doChorus", [chorusRate, delayTime, chorusDepth, flow]);
+        const args = JSInterface.validateArgs("doChorus", [
+            chorusRate,
+            delayTime,
+            chorusDepth,
+            flow
+        ]);
         await this.runCommand("doChorus", [args[0], args[1], args[2], this.turIndex]);
         await args[3]();
         return this.ENDFLOWCOMMAND;

diff --git a/js/js-export/API/VolumeBlocksAPI.js b/js/js-export/API/VolumeBlocksAPI.js
@@ -13,7 +13,11 @@
  * You should have received a copy of the GNU Affero General Public License along with this
  * library; if not, write to the Free Software Foundation, 51 Franklin Street, Suite 500 Boston,
  * MA 02110-1335 USA.
-*/
+ */
+
+/* global JSInterface, Singer */
+
+/* exported VolumeBlocksAPI */
 
 /**
  * Class pertaining to the API methods specific to Volume blocks for JavaScript based Music Blocks

diff --git a/js/js-export/ASTutils.js b/js/js-export/ASTutils.js
@@ -19,6 +19,10 @@
  * Private members' names begin with underscore '_".
  */
 
+/* global JSInterface, last */
+
+/* exported ASTUtils */
+
 /**
  * @class
  * @classdesc contains the barebone ASTs and utilities for generating the Abstract Syntax Tree for

diff --git a/js/js-export/constraints.js b/js/js-export/constraints.js
@@ -14,6 +14,8 @@
  * MA 02110-1335 USA.
  */
 
+/* global JSInterface */
+
 /**
  * @static
  * lookup table for API method names to argument constraints
@@ -990,24 +992,24 @@ JSInterface._methodArgConstraints = {
             }
         }
     ],
-    setBezierControlPoint1: [
-        {
-            type: "number",
-            constraints: {
-                min: -100000,
-                max: 100000,
-                integer: false
-            }
-        },
-        {
-            type: "number",
-            constraints: {
-                min: -100000,
-                max: 100000,
-                integer: false
-            }
-        }
-    ],
+    // setBezierControlPoint1: [
+    //     {
+    //         type: "number",
+    //         constraints: {
+    //             min: -100000,
+    //             max: 100000,
+    //             integer: false
+    //         }
+    //     },
+    //     {
+    //         type: "number",
+    //         constraints: {
+    //             min: -100000,
+    //             max: 100000,
+    //             integer: false
+    //         }
+    //     }
+    // ],
     scrollXY: [
         {
             type: "number",

diff --git a/js/js-export/export.js b/js/js-export/export.js
@@ -18,6 +18,8 @@
  * Internal functions' names are in PascalCase.
  */
 
+/* global JSEditor, turtles, last, importMembers, logo, Singer, JSInterface */
+
 /**
  * @class
  * @classdesc pertains to the Mouse (corresponding to Turtle) in JavaScript based Music Blocks programs.
@@ -46,6 +48,7 @@ class Mouse {
         this.turtle.initTurtle(false);
 
         this.flow = flow;
+        // eslint-disable-next-line no-use-before-define
         this.MB = new MusicBlocks(this); // associate a MusicBlocks object with each Mouse
 
         Mouse.MouseList.push(this);

diff --git a/js/js-export/generate.js b/js/js-export/generate.js
@@ -1,3 +1,4 @@
+/* eslint-disable no-console */
 /**
  * @file This contains the utilities for generating code from block stacks for JS Editor widget.
  * @author Anindya Kundu
@@ -14,6 +15,10 @@
  * MA 02110-1335 USA.
  */
 
+/* global JSInterface, blocks, last, ASTUtils, astring */
+
+/* exported JSGenerate */
+
 /**
  * @class
  * @classdesc

diff --git a/js/js-export/interface.js b/js/js-export/interface.js
@@ -17,6 +17,10 @@
  * Private members' names begin with underscore '_".
  */
 
+/* global JSEditor, SHARP, FLAT, NATURAL, DOUBLESHARP, DOUBLEFLAT */
+
+/* exported JSInterface */
+
 /**
  * @class
  * @classdesc contains the lists and lookups for relevant blocks, and utility methods to access them.
@@ -374,7 +378,7 @@ class JSInterface {
                     if (!isNaN(Number(arg))) {
                         arg = Number(arg);
                     } else {
-                        const error = "TypeMismatch error: expected \"number\" but found \"string\"";
+                        const error = 'TypeMismatch error: expected "number" but found "string"';
                         JSEditor.logConsole(error, "maroon");
                         throw error;
                     }

diff --git a/js/js-export/samples/sample.js b/js/js-export/samples/sample.js
@@ -14,6 +14,8 @@
  * MA 02110-1335 USA.
  */
 
+/* exported JS_API, JS_STARTER, SAMPLE_1, SAMPLE_2 */
+
 const JS_API = `/*
 ============================================================
        API