Lint

nwutils · Dec 17, 2023 · f90d3ad · f90d3ad
1 parent 8e5d00b
commit f90d3ad
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -64,7 +64,7 @@ nwSplasherAutoUpdate.downloadLatestAppAndOpenWindowInBackground({
      * @return {string}              The new version number (continue to download zip), or false (open current version)
      */
     confirmNewVersion: function (response, latestLocal) {
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       response = JSON.parse(response);
       const latestRemote = response.latest.version;
       const updateAvailable = require('semver').gt(latestRemote, latestLocal);
@@ -75,13 +75,13 @@ nwSplasherAutoUpdate.downloadLatestAppAndOpenWindowInBackground({
     },
     /**
      * Called after hitting the versionUrl with the response.
-     * Must return a url to a ZIP file to be downloaded/extracted
+     * Must return a url to a ZIP file to be downloaded/extracted.
      *
      * @param  {string} response  The response body from the network request
      * @return {string}           A url to a ZIP file to be downloaded
      */
     downloadPath: function (response) {
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       response = JSON.parse(response);
       return response.latest.downloadUrl;
     },
@@ -96,7 +96,7 @@ nwSplasherAutoUpdate.downloadLatestAppAndOpenWindowInBackground({
      * @param {number} update.extractProgress   The extract progress percent
      */
     onUpdate: function ({ downloadProgress, extractProgress }) {
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       if (downloadProgress) {
         console.log('Download progress: ' + downloadProgress + '%');
       }
@@ -111,10 +111,10 @@ nwSplasherAutoUpdate.downloadLatestAppAndOpenWindowInBackground({
      * nwSplasherAutoUpdate will retry or stop running.
      *
      * @param  {string}  pathToZip  File path to the downloaded zip file
-     * @return {Boolean}            true = continue, false = retry/stop
+     * @return {boolean}            true = continue, false = retry/stop
      */
     validateZip: function (pathToZip) {
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       return true;
     },
     /**
@@ -124,10 +124,10 @@ nwSplasherAutoUpdate.downloadLatestAppAndOpenWindowInBackground({
      * then nwSplasherAutoUpdate will retry or stop running.
      *
      * @param  {string}  pathToExtract  File path to the downloaded zip file
-     * @return {Boolean}                true = continue, false = retry/stop
+     * @return {boolean}                true = continue, false = retry/stop
      */
     validateExtract: function (pathToExtract) {
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       return true;
     },
     /**
@@ -137,7 +137,7 @@ nwSplasherAutoUpdate.downloadLatestAppAndOpenWindowInBackground({
      * @param {string} message  Human readable warning message
      */
     onRetry: function (message) {
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       console.log(message);
     },
     /**
@@ -149,7 +149,7 @@ nwSplasherAutoUpdate.downloadLatestAppAndOpenWindowInBackground({
      * @param {object} error         Detailed error information if available
      */
     onError: function (errorMessage, error) {
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       console.log(errorMessage, error);
     },
     /**

diff --git a/manual-testing.js b/manual-testing.js
@@ -4,9 +4,10 @@
  * @file Used for manually testing the code
  */
 
-const library = require('./index.js');
 const semver = require('semver');
 
+const library = require('./index.js');
+
 let options = {
   autoUpdate: {
     versionUrl: 'https://api.github.com/repos/scout-app/scout-app/releases',
@@ -83,14 +84,14 @@ options = {
     },
     /**
      * Called after hitting the versionUrl with the response.
-     * Must return a url to a ZIP file to be downloaded/extracted
+     * Must return a url to a ZIP file to be downloaded/extracted.
      *
      * @param  {string} response  The response body from the network request
      * @return {string}           A url to a ZIP file to be downloaded
      */
     downloadPath: function (response) {
       console.log('downloadPath');
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       response = JSON.parse(response);
       return response.latest.downloadUrl;
     },
@@ -106,7 +107,7 @@ options = {
      */
     onUpdate: function ({ downloadProgress, extractProgress }) {
       console.log('onUpdate');
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       if (downloadProgress) {
         console.log('Download progress: ' + downloadProgress + '%');
       }
@@ -121,11 +122,11 @@ options = {
      * nwSplasherAutoUpdate will retry or stop running.
      *
      * @param  {string}  pathToZip  File path to the downloaded zip file
-     * @return {Boolean}            true = continue, false = retry/stop
+     * @return {boolean}            true = continue, false = retry/stop
      */
     validateZip: function (pathToZip) {
-      console.log('validateZip');
-      //This is just an example, you can put any logic you want here
+      console.log('validateZip', pathToZip);
+      // This is just an example, you can put any logic you want here
       return true;
     },
     /**
@@ -135,11 +136,11 @@ options = {
      * then nwSplasherAutoUpdate will retry or stop running.
      *
      * @param  {string}  pathToExtract  File path to the downloaded zip file
-     * @return {Boolean}                true = continue, false = retry/stop
+     * @return {boolean}                true = continue, false = retry/stop
      */
     validateExtract: function (pathToExtract) {
-      console.log('validateExtract');
-      //This is just an example, you can put any logic you want here
+      console.log('validateExtract', pathToExtract);
+      // This is just an example, you can put any logic you want here
       return true;
     },
     /**
@@ -149,7 +150,7 @@ options = {
      * @param {string} message  Human readable warning message
      */
     onRetry: function (message) {
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       console.log('onRetry', message);
     },
     /**
@@ -161,7 +162,7 @@ options = {
      * @param {object} error         Detailed error information if available
      */
     onError: function (errorMessage, error) {
-      //This is just an example, you can put any logic you want here
+      // This is just an example, you can put any logic you want here
       console.log('onError', errorMessage, error);
     },
     /**

diff --git a/src/getLatestLocal.js b/src/getLatestLocal.js
@@ -9,21 +9,23 @@ const { OPTIONS } = require('../api-type-definitions.js');
 const helpers = require('./helpers.js');
 
 /**
- *
+ * Checks the previously downloaded app versions to find
+ * the most recenter version number. If no local versions
+ * are found, returns false.
  *
  * @param  {OPTIONS} options  User's validated options
- * @return {Promise}          .
+ * @return {string}           The most recent local version number, or false
  */
 async function getLatestLocal (options) {
-  return new Promise((resolve, reject) => {
-    let latestLocal = '0.0.0';
-    if (latestLocal) {
-      resolve(latestLocal);
-    } else {
-      helpers.throwError(options, 'Error getting latest local version number', error);
-      reject();
-    }
-  });
+  console.log('Th getLatestLocal function is a stub and needs implemented');
+  let latestLocal = '0.0.0';
+  if (latestLocal) {
+    return latestLocal;
+  } else {
+    let error;
+    helpers.throwError(options, 'Error getting latest local version number', error);
+  }
+  return false;
 };
 
 module.exports = getLatestLocal;