chore: upgrade dev dependencies and fix eslint errors/warnings (twili…

…o#157)
shrutiburman · Mar 12, 2020 · 151e3cc · 151e3cc
1 parent d30ba2e
commit 151e3cc
Show file tree

Hide file tree

Showing 14 changed files with 1,218 additions and 949 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,17 +28,16 @@
     "@oclif/dev-cli": "^1.22.2",
     "@oclif/test": "^1.2.5",
     "@twilio/cli-test": "^2.0.2",
-    "aws-sdk": "^2.612.0",
+    "aws-sdk": "^2.638.0",
     "chai": "^4.2.0",
-    "eslint": "^4.19.1",
-    "eslint-config-oclif": "^1.5.1",
-    "eslint-plugin-mocha": "^5.2.1",
-    "globby": "^10.0.1",
-    "mocha": "^6.2.2",
-    "nock": "^11.7.0",
-    "nyc": "^14.1.1",
-    "rimraf": "^2.7.1",
-    "sinon": "^7.5.0",
+    "eslint": "^6.8.0",
+    "eslint-config-oclif": "^3.1.0",
+    "eslint-plugin-mocha": "^6.3.0",
+    "globby": "^11.0.0",
+    "mocha": "^7.1.0",
+    "nock": "^12.0.2",
+    "nyc": "^15.0.0",
+    "sinon": "^9.0.1",
     "tmp": "^0.1.0"
   },
   "engines": {
@@ -105,7 +104,7 @@
     "url": "https://github.com/twilio/twilio-cli.git"
   },
   "scripts": {
-    "postpack": "rimraf oclif.manifest.json npm-shrinkwrap.json",
+    "postpack": "rm -f oclif.manifest.json npm-shrinkwrap.json",
     "posttest": "eslint --ignore-path .gitignore . && npm audit",
     "prepack": "oclif-dev manifest && oclif-dev readme && npm shrinkwrap && git checkout -- package-lock.json",
     "test": "nyc --check-coverage --lines 90 --reporter=html --reporter=text mocha --forbid-only \"test/**/*.test.js\"",

diff --git a/src/commands/email/send.js b/src/commands/email/send.js
@@ -115,8 +115,8 @@ class Send extends BaseCommand {
     try {
       const coded = fs.readFileSync(filePath, 'base64');
       return coded;
-    } catch (err) {
-      this.logger.debug(err);
+    } catch (error) {
+      this.logger.debug(error);
       throw new TwilioCliError('Unable to read the file: ' + filePath);
     }
   }

diff --git a/src/commands/phone-numbers/update.js b/src/commands/phone-numbers/update.js
@@ -103,6 +103,7 @@ class NumberUpdate extends TwilioClientCommand {
     }
 
     // Build the new prop value using the tunnel URL.
+    // eslint-disable-next-line require-atomic-updates
     props[propName] = newBaseUrl + url.pathname + url.search;
   }
 

diff --git a/src/commands/profiles/create.js b/src/commands/profiles/create.js
@@ -202,9 +202,9 @@ class ProfilesCreate extends BaseCommand {
       // Don't log the response since it contains the account auth token.
       await twilioClient.api.accounts(this.accountSid).fetch();
       return true;
-    } catch (err) {
+    } catch (error) {
       this.logger.error('Could not validate the provided credentials. Not saving.');
-      this.logger.debug(err);
+      this.logger.debug(error);
       return false;
     }
   }
@@ -218,9 +218,9 @@ class ProfilesCreate extends BaseCommand {
   getUsername() {
     try {
       return os.userInfo().username;
-    } catch (err) {
+    } catch (error) {
       // Throws a SystemError if a user has no username or homedir.
-      this.logger.debug(err);
+      this.logger.debug(error);
     }
   }
 
@@ -232,8 +232,8 @@ class ProfilesCreate extends BaseCommand {
     try {
       apiKey = await twilioClient.newKeys.create({ friendlyName: apiKeyFriendlyName });
       this.logger.debug(apiKey);
-    } catch (err) {
-      this.logger.debug(err);
+    } catch (error) {
+      this.logger.debug(error);
       throw new TwilioCliError('Could not create an API Key.');
     }
 

diff --git a/src/commands/profiles/remove.js b/src/commands/profiles/remove.js
@@ -50,9 +50,9 @@ class ProfilesRemove extends TwilioClientCommand {
       try {
         await this.twilioClient.api.keys(credentials.apiKey).remove();
         this.logger.info('The API Key has been deleted from The Twilio console.');
-      } catch (err) {
+      } catch (error) {
         this.logger.error('Could not delete the API Key. See: https://www.twilio.com/console/runtime/api-keys to delete the API Key from The Twilio Console.');
-        this.logger.debug(err.message);
+        this.logger.debug(error.message);
       }
     }
     if (keyVerdict === false) {

diff --git a/src/hooks/init/twilio-api.js b/src/hooks/init/twilio-api.js
@@ -77,7 +77,7 @@ class TwilioRestApiPlugin extends Plugin {
   /**
    * Attempts to get the hostname from first path's server. Falls back to using the domain name.
    *
-   * @param actionDefinition - action containing domain paths
+   * @param {Object} actionDefinition - action containing domain paths
    * @returns {string} - Target hostname for the action
    */
   getHostname(actionDefinition) {

diff --git a/src/services/api-schema/schema-validator.js b/src/services/api-schema/schema-validator.js
@@ -4,9 +4,9 @@ const TwilioSchemaValidator = require('./twilio-validator');
  * Validates an object's value against a given schema. Uses the Twilio schema
  * validator.
  *
- * @param schema {Object} - object to validate against
- * @param value {Object} - object to validate
- * @param logger {Logger} - debug logger
+ * @param {Object} schema - object to validate against
+ * @param {Object} value - object to validate
+ * @param {Logger} logger - debug logger
  * @returns {Array} - validation errors strings
  */
 function validateSchema(schema, value, logger) {

diff --git a/src/services/resource-helpers/api/v2010/incoming-phone-number.js b/src/services/resource-helpers/api/v2010/incoming-phone-number.js
@@ -12,8 +12,8 @@ class IncomingPhoneNumberHelper {
     if (sid) {
       try {
         response = await this.twilioClient.incomingPhoneNumbers(sid).fetch();
-      } catch (err) {
-        const errorMessage = err.code === 20404 ? 'Could not find phone number ' + userInput : err.message;
+      } catch (error) {
+        const errorMessage = error.code === 20404 ? 'Could not find phone number ' + userInput : error.message;
         throw new TwilioCliError(errorMessage);
       }
       return response;
@@ -22,8 +22,8 @@ class IncomingPhoneNumberHelper {
     let matches;
     try {
       matches = await this.twilioClient.incomingPhoneNumbers.list({ phoneNumber: userInput });
-    } catch (err) {
-      throw new TwilioCliError(err.message);
+    } catch (error) {
+      throw new TwilioCliError(error.message);
     }
 
     if (matches && matches.length > 0) return matches[0];

diff --git a/src/services/twilio-api/get-flag-config.js b/src/services/twilio-api/get-flag-config.js
@@ -21,6 +21,10 @@ const getFlagName = paramName => {
 
 /**
  * Converts a Twilio API parameter into a Twilio CLI flag.
+ *
+ * @param {Object} parameter - Twilio API parameter
+ * @param {Object} actionDefinition - action containing topic, command, and domain names
+ * @returns {Object} - Twilio CLI flag configuration
  */
 const getFlagConfig = (parameter, actionDefinition) => {
   let flagName = getFlagName(parameter.name);

diff --git a/test/.mocharc.yml b/test/.mocharc.yml
@@ -0,0 +1,4 @@
+require: test/helpers/init.js
+recursive: true
+reporter: spec
+timeout: 10000
diff --git a/test/base-commands/twilio-api-command.test.js b/test/base-commands/twilio-api-command.test.js
@@ -58,7 +58,8 @@ describe('base-commands', () => {
       };
 
       const getCommandClass = (actionDefinition = callCreateActionDefinition) => {
-        const NewCommandClass = class extends TwilioApiCommand { };
+        const NewCommandClass = class extends TwilioApiCommand {
+        };
         NewCommandClass.actionDefinition = actionDefinition;
         NewCommandClass.actionDefinition.topicName = 'api:' + getTopicName(NewCommandClass.actionDefinition);
         TwilioApiCommand.setUpNewCommandClass(NewCommandClass);
@@ -119,9 +120,12 @@ describe('base-commands', () => {
         .stdout()
         .stderr()
         .twilioCreateCommand(getCommandClass(), [
-          '--from', '+15555555555',
-          '--to', '+14155555555',
-          '--url', 'http://example.com/'
+          '--from',
+          '+15555555555',
+          '--to',
+          '+14155555555',
+          '--url',
+          'http://example.com/'
         ])
         .do(ctx => {
           ctx.testCmd.twilioApi = { create: sinon.stub().returns(fakeCallResponse) };
@@ -137,9 +141,12 @@ describe('base-commands', () => {
         .stdout()
         .stderr()
         .twilioCreateCommand(getCommandClass(callListActionDefinition), [
-          '--start-time-after', 'after-this',
-          '--start-time-before', 'before-that',
-          '--limit', '1'
+          '--start-time-after',
+          'after-this',
+          '--start-time-before',
+          'before-that',
+          '--limit',
+          '1'
         ])
         .do(ctx => {
           ctx.testCmd.twilioApi = { list: sinon.stub().returns([]) };
@@ -175,9 +182,12 @@ describe('base-commands', () => {
         .twilioCliEnv(Config)
         .stderr()
         .twilioCreateCommand(getCommandClass(numberUpdateActionDefinition), [
-          '--sid', fakeCallResponse.sid,
-          '--account-sid', 'AC012',
-          '--target-account-sid', 'AC123'
+          '--sid',
+          fakeCallResponse.sid,
+          '--account-sid',
+          'AC012',
+          '--target-account-sid',
+          'AC123'
         ])
         .do(ctx => {
           ctx.testCmd.twilioApi = { update: sinon.stub().returns({}) };
@@ -193,10 +203,14 @@ describe('base-commands', () => {
         .twilioCliEnv(Config)
         .stderr()
         .twilioCommand(getCommandClass(), [
-          '--from', '+15555555555',
-          '--to', '+14155555555',
-          '--url', 'http://example.com/',
-          '--application-sid', 'ap12345678901234567890123456789012' // Lower-cased 'ap'
+          '--from',
+          '+15555555555',
+          '--to',
+          '+14155555555',
+          '--url',
+          'http://example.com/',
+          '--application-sid',
+          'ap12345678901234567890123456789012' // Lower-cased 'ap'
         ])
         .catch(/Cannot execute command/)
         .it('exits with a failure code and prints validation errors', ctx => {
@@ -210,10 +224,14 @@ describe('base-commands', () => {
         .stderr()
         .twilioCreateCommand(getCommandClass(), [
           '--skip-parameter-validation',
-          '--from', '+15555555555',
-          '--to', '+14155555555',
-          '--url', 'http://example.com/',
-          '--application-sid', 'ap12345678901234567890123456789012' // Lower-cased 'ap'
+          '--from',
+          '+15555555555',
+          '--to',
+          '+14155555555',
+          '--url',
+          'http://example.com/',
+          '--application-sid',
+          'ap12345678901234567890123456789012' // Lower-cased 'ap'
         ])
         .do(ctx => {
           ctx.testCmd.twilioApi = { create: sinon.stub().returns(fakeCallResponse) };

diff --git a/test/hooks/init/buy-phone-number.test.js b/test/hooks/init/buy-phone-number.test.js
@@ -89,8 +89,10 @@ describe('hooks', () => {
         .twilioFakeProfile(ConfigData)
         .twilioCliEnv(Config)
         .twilioCreateCommand(getBuyLocalCommand(), [
-          '--country-code', TEST_COUNTRY_CODE,
-          '--area-code', TEST_AREA_CODE
+          '--country-code',
+          TEST_COUNTRY_CODE,
+          '--area-code',
+          TEST_AREA_CODE
         ])
         .stderr()
         .do(ctx => {

diff --git a/test/mocha.opts b/test/mocha.opts
-Original file line number
+Diff line change
@@ Expand Up / @@ -103,6 +103,7 @@ class NumberUpdate extends TwilioClientCommand { @@
         }
         // Build the new prop value using the tunnel URL.
+        // eslint-disable-next-line require-atomic-updates
         props[propName] = newBaseUrl + url.pathname + url.search;
       }
@@ Expand Down @@