Merge branch 'master' of https://github.com/rikkuness/EspruinoTools into packetsend

Author: rikkuness

.eslintrc.js

@@ -23,5 +23,6 @@ module.exports = {
     "no-var": "off",
     "no-unused-vars": ["warn", { args: "none" }],
     "no-control-regex": "off",
+    "brace-style": ["warn", "1tbs", { "allowSingleLine": true }]
   },
 };

bin/espruino-cli.js

@@ -756,8 +756,7 @@ function terminal(devicePath, exitCallback) {
           if (args.watchFile) sendOnFileChanged();
         });
       });
-    }
-    else {
+    } else {
       // figure out what code we need to send (if any)
       sendCode(function() {
         if (args.watchFile) sendOnFileChanged();

core/codeWriter.js

@@ -74,7 +74,11 @@
     });
   }
 
-  /// Parse and fix issues like `if (false)\n foo` in the root scope
+  /**
+   * Parse and fix issues like `if (false)\n foo` in the root scope
+   * @param {string} code 
+   * @returns {string | undefined}
+   */
   function reformatCode(code) {
     var APPLY_LINE_NUMBERS = false;
     var lineNumberOffset = 0;

core/config.js

@@ -108,12 +108,13 @@
       Espruino.Config[name] = options.defaultValue;
   }
 
-  /** Add a section (or information on the page).
-   * options = {
-   *   sortOrder : int, // a number used for sorting
-   *   description : "",
-   *   getHTML : function(callback(html)) // optional
-   * };
+  /**
+   * Add a section (or information on the page).
+   * @param {string} name 
+   * @param {Object} options 
+   * @param {number} options.sortOrder a number used for sorting
+   * @param {string} options.description
+   * @param {() => void | undefined} options.getHTML
    */
   function addSection(name, options) {
     options.name = name;
@@ -176,7 +177,8 @@
     }
   };
 
-  function clearAll() { // clear all settings
+  /** Clear all settings */
+  function clearAll() {
     _set({});
     for (var name in Espruino.Core.Config.data) {
       var options = Espruino.Core.Config.data[name];
@@ -185,7 +187,8 @@
   }
 
   Espruino.Core.Config = {
-      loadConfiguration : loadConfiguration, // special - called before init
+      /** special - called before init */
+      loadConfiguration : loadConfiguration, 
 
       init : init,
       add : add,
@@ -196,7 +199,8 @@
       getSection : getSection,
       getSections : getSections,
 
-      clearAll : clearAll, // clear all settings
+      /** Clear all settings */
+      clearAll : clearAll, 
   };
 
 })();

core/flasher.js

@@ -392,6 +392,7 @@
       Espruino.Core.Terminal.setInputDataHandler(oldHandler);
       callback(err);
     };
+
     // initialise
     initialiseChip(function (err) {
       if (err) return finish(err);

core/flasherESP8266.js

@@ -21,26 +21,33 @@
   function init() {
   }
 
+  /**
+   * @typedef {Object} FlasherOptions
+   * @property {ArrayBuffer} binary
+   * @property {(status: string) => void} cbStatus
+   * @property {(err: Error) => void} cbDone
+   * @property {string} serialDevice Serial2
+   * @property {string} serialRx A3
+   * @property {string} serialTx A2
+   * @property {string} chBoot A14
+   * @property {string} chPD A13
+   */
+
+  /** 
+   * @param {FlasherOptions} options
+   * @returns {FlasherOptions}
+   */
   function defaultOptions(options) {
     options.serialDevice = options.serialDevice||"Serial2";
     options.serialRx = options.serialRx||"A3";
     options.serialTx = options.serialTx||"A2";
   }
 
-  /* options = {
-    binary : ArrayBuffer,
-    cbStatus,
-    cbDone,
-    serialDevice, // Serial2
-    serialRx, // A3
-    serialTx, // A2
-    chBoot, // A14
-    chPD, // A13
-     */
+  /** @param {FlasherOptions} options  */
   function flashDevice(options) {
     if (!options.binary) throw new Error("Needs binary");
     defaultOptions(options);
-
+    
     var prevReader = Espruino.Core.Serial.startListening(function (buffer) {
       var bufView = new Uint8Array(buffer);
       for (var i=0;i<bufView.length;i++)
@@ -84,7 +91,11 @@
     });
   }
 
-
+/**
+ * @param {FlasherOptions} options 
+ * @param {number} cmd 
+ * @param {ArrayBuffer} data 
+ */
 function wr(options,cmd,data) {
   //console.log("Write",cmd,data.length,data);
   if (typeof data !== "string")
@@ -112,6 +123,7 @@ function sendCmd(options, cmd, data) {
   });
 }
 
+/** @param {FlasherOptions} options  */
 function setupEspruino(options) {
   if (options.cbStatus) options.cbStatus("Configuring Espruino...");
   return new Promise((resolve,reject)=>{
@@ -152,6 +164,7 @@ function setupEspruino(options) {
   });
 }
 
+/** @param {FlasherOptions} options  */
 function unsetupEspruino(options) {
   if (options.cbStatus) options.cbStatus("Resetting Espruino...");
   return new Promise((resolve,reject)=>{
@@ -163,6 +176,7 @@ function unsetupEspruino(options) {
   });
 }
 
+/** @param {FlasherOptions} options  */
 function cmdSync(options) {
   console.log("Syncing...");
   return new Promise((resolve,reject)=>{
@@ -197,8 +211,7 @@ function cmdSync(options) {
   });
 }
 
-
-
+/** @param {FlasherOptions} options  */
 function cmdFlash(options) {
   var binary = new Uint8Array(options.binary);
   var blockCount = Math.floor((binary.length + (BLOCK_SIZE-1)) / BLOCK_SIZE);
@@ -227,6 +240,10 @@ function cmdFlash(options) {
   });
 }
 
+/**
+ * @param {FlasherOptions} options 
+ * @param {(version: string) => void} callback 
+ */
 function getFirmwareVersion(options, callback) {
   defaultOptions(options);
   Espruino.Core.Serial.write('\x03\x10reset()\n', false, function() {

core/notifications.js

@@ -13,26 +13,20 @@
 
 (function() {
 
-  function init()
-  {
-  }
+  function init() { }
 
   Espruino.Core.Notifications = {
       init : init,
-      success: function(msg, setStatus)
-      {
+      success: function(msg, setStatus) {
         toastr.success(msg);
       },
-      error: function(msg, setStatus)
-      {
+      error: function(msg, setStatus) {
         toastr.error(msg);
       },
-      warning: function(msg, setStatus)
-      {
+      warning: function(msg, setStatus) {
         Espruino.callProcessor("notification",{type:"warning",msg:msg},function(){});
       },
-      info: function(msg, setStatus)
-      {
+      info: function(msg, setStatus) {
         Espruino.callProcessor("notification",{type:"info",msg:msg},function(){});
       }
   };

core/serial_noble.js

@@ -60,7 +60,8 @@
     try {
       process.on('uncaughtException', nobleExceptionHandler);
       if (Espruino.Core.Utils.isWindows()) { // ONLY try on windows - this breaks other OSes
-        try { noble = require('noble-winrt'); // for windows 10+ compat. noble-uwp should work too
+        try {
+          noble = require('noble-winrt'); // for windows 10+ compat. noble-uwp should work too
         } catch (e) {
           console.log("Noble: noble-winrt not available",e);
         }
@@ -240,7 +241,7 @@
     }
   };
 
-  // Throttled serial write
+  /** Throttled serial write */
   var writeSerial = function (data, callback) {
     if (txCharacteristic === undefined) return;
 

core/serial_node_ble.js

@@ -194,7 +194,7 @@
     });
   };
 
-  // Throttled serial write
+  /** Throttled serial write */
   var writeSerial = function (data, callback) {
     if (txCharacteristic === undefined) return;
 

core/serial_web_audio.js

@@ -2,6 +2,10 @@
 
   var BAUD = 9600;
 
+  /**
+   * @param {boolean} ignoreSettings 
+   * @returns {{warning?: string, error?: string} | boolean}
+   */
   function getStatus(ignoreSettings) {
     if (typeof navigator == "undefined" || typeof window == "undefined") {
       return {warning:"Not running in a browser"};

core/serial_web_bluetooth.js

@@ -9,6 +9,10 @@
      isSupportedByBrowser=true;
   }
 
+  /**
+   * @param {boolean} ignoreSettings 
+   * @returns {{warning?: string, error?: string} | boolean}
+   */
   function getStatus(ignoreSettings) {
     /* If BLE is handled some other way (eg noble), then it can be disabled here */
     if (Espruino.Core.Serial.NO_WEB_BLUETOOTH) {

core/terminal.js

@@ -49,8 +49,7 @@
   // maximum lines on the terminal
   var MAX_LINES = 2048;
 
-  function init()
-  {
+  function init() {
     // Add stuff we need
     document.querySelector(".editor--terminal .editor__canvas").innerHTML = '<textarea id="terminalfocus" class="terminal__focus" rows="1" cols="1" style="z-index:-100;position:absolute;left:0px;top:0px;"></textarea><div id="terminal" class="terminal"></div>';
 
@@ -647,8 +646,7 @@
         Espruino.callProcessor("getWatched",receivedData,function(){});
         receivedData = "";
       }
-    }
-    else{ receivedData = ""; }
+    } else{ receivedData = ""; }
   }
 
   /// Claim input and output of the Serial port