Merge pull request #384 from smartdevicelink/bugfix/resolve-linter-issues

Fix linter issues

Author: crokita

lib/js/src/manager/screen/utils/VoiceCommand.js

@@ -138,8 +138,8 @@ class VoiceCommand {
         if (voiceCommands.length !== otherVoiceCommands.length) {
             return false;
         }
-        for (let i = 0; i < voiceCommands.length; i++) {
-            if (voiceCommands[i] !== otherVoiceCommands[i]) {
+        for (let index = 0; index < voiceCommands.length; index++) {
+            if (voiceCommands[index] !== otherVoiceCommands[index]) {
                 return false;
             }
         }

lib/js/src/manager/screen/utils/_VoiceCommandUpdateOperation.js

@@ -61,7 +61,7 @@ class _VoiceCommandUpdateOperation extends _Task {
     /**
      * The method that causes the task to run.
      * @param {_Task} task - The task instance
-     * @returns {Promise}
+     * @returns {Promise} - This promise does not resolve to any value
      */
     async onExecute (task) {
         if (this.getState() === _Task.CANCELED) {

lib/js/src/protocol/_SdlPacket.js

@@ -36,7 +36,7 @@ import  { _Bson } from './../util/_Bson.js';
 /**
  * @typedef {Object} _SdlPacket
  * @property {number} _EXTRA_PARCEL_DATA_LENGTH
- * @property @private {number} _HEADER_SIZE
+ * @property {number} _HEADER_SIZE
  * @property {number} SERVICE_TYPE_CONTROL
  * @property {number} SERVICE_TYPE_RPC
  * @property {number} SERVICE_TYPE_PCM

tests/managers/screen/VoiceCommandManagerTests.js

@@ -42,12 +42,12 @@ module.exports = async function (appClient) {
             Validator.assertEquals(voiceCommandManager.getVoiceCommands().length, 2);
             Validator.assertEquals(voiceCommandManager._currentVoiceCommands.length, 0);
             Validator.assertEquals(voiceCommandManager._currentHmiLevel, SDL.rpc.enums.HMILevel.HMI_NONE);
-            
+
             voiceCommandManager.setVoiceCommands([]); // don't operate on the voice commands when the manager gets an HMI_FULL
             // The VCM should send the pending voice commands once HMI full occurs
             // fake sending an OnHMILevel update
             voiceCommandManager._hmiListener(new SDL.rpc.messages.OnHMIStatus()
-                .setHmiLevel(SDL.rpc.enums.HMILevel.HMI_FULL))
+                .setHmiLevel(SDL.rpc.enums.HMILevel.HMI_FULL));
 
             Validator.assertEquals(voiceCommandManager._currentHmiLevel, SDL.rpc.enums.HMILevel.HMI_FULL);
         });
@@ -62,8 +62,8 @@ module.exports = async function (appClient) {
             // Fake onCommand - we want to make sure that we can pass back onCommand events to our VoiceCommand Objects
             voiceCommandManager._commandListener(new SDL.rpc.messages.OnCommand()
                 .setCmdID(voiceCommand3._getCommandId())
-                .setTriggerSource(SDL.rpc.enums.TriggerSource.TS_VR)) // these are voice commands
-        
+                .setTriggerSource(SDL.rpc.enums.TriggerSource.TS_VR)); // these are voice commands
+
             // verify the mock listener has been hit once
             Validator.assertEquals(callback.calledOnce, true);
         });

tests/managers/screen/VoiceCommandUpdateOperationTests.js

@@ -9,7 +9,6 @@ const Validator = require('../../Validator');
 module.exports = function (appClient) {
     describe('VoiceCommandUpdateOperationTests', function () {
         const sdlManager = appClient._sdlManager;
-        const voiceCommandManager = sdlManager.getScreenManager()._voiceCommandManager;
         const lifecycleManager = sdlManager._lifecycleManager;
 
         const voiceCommand1 = new SDL.manager.screen.utils.VoiceCommand(['Command 1'], () => {});
@@ -103,6 +102,11 @@ module.exports = function (appClient) {
             stub.restore();
         });
 
+        /**
+         * Will always resolve successfully
+         * @param {AddCommand|DeleteCommand} req - The RPC to send out as a request
+         * @returns {AddCommandResponse|DeleteCommandResponse} - The rpc returned depends on the request
+         */
         function onDeleteOrAddCommandSuccess (req) {
             const functionId = req.getFunctionId();
 
@@ -120,6 +124,11 @@ module.exports = function (appClient) {
             }
         }
 
+        /**
+         * Will always resolve unsuccessfully
+         * @param {AddCommand|DeleteCommand} req - The RPC to send out as a request
+         * @returns {AddCommandResponse|DeleteCommandResponse} - The rpc returned depends on the request
+         */
         function onDeleteOrAddCommandFails (req) {
             const functionId = req.getFunctionId();