Merge branch 'main' into harshit-bs/3706

harshit-bs · Sep 22, 2023 · 1fb8512 · 1fb8512
2 parents 12b3cfe + 17a5d7b
commit 1fb8512
Show file tree

Hide file tree

Showing 236 changed files with 3,982 additions and 2,333 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -1,9 +1,10 @@
 {
+  "root": true,
   "extends": [
     "eslint:recommended"
   ],
   "parserOptions": {
-    "ecmaVersion": 2020,
+    "ecmaVersion": 13,
     "sourceType": "module",
     "ecmaFeatures": {
       "jsx": false
@@ -13,6 +14,33 @@
     "mocha": true,
     "node": true
   },
+  "overrides": [
+    {
+      "files": [
+        "**/*.ts"
+      ],
+      "excludedFiles": [
+        "test/**/*.ts"
+      ],
+      "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended"
+      ],
+      "parser": "@typescript-eslint/parser",
+      "plugins": [
+        "@typescript-eslint"
+      ],
+      "parserOptions": {
+        "ecmaVersion": 2020,
+        "sourceType": "module",
+        "ecmaFeatures": {
+          "jsx": false
+        },
+        "project": "./tsconfig.json"
+      }
+    }
+  ],
   "rules": {
     "eqeqeq": [
       "error",
@@ -43,13 +71,13 @@
         "omitLastInOneLineBlock": true
       }
     ],
-    "no-trailing-spaces": 0,
+    "no-trailing-spaces": 1,
     "no-else-return": 2,
     "no-extra-bind": 0,
     "no-implicit-coercion": 0,
     "no-useless-call": 0,
     "no-return-assign": 0,
-    "eol-last": 0,
+    "eol-last": 1,
     "no-unused-vars": 0,
     "no-extra-semi": 0,
     "comma-dangle": 2,
@@ -86,6 +114,7 @@
         "after": true
       }
     ],
+    "space-infix-ops": 1,
     "padding-line-between-statements": [
       "error",
       {

diff --git a/.github/workflows/build-node.yaml b/.github/workflows/build-node.yaml
@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node-version: [14.x, 16.x, 18.x]
+        node-version: [16.x, 18.x, 20.x]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:

diff --git a/api/index.js b/api/index.js
@@ -16,7 +16,7 @@ const exportedCommands = [
 const basePath = '../dist/api';
 const Commands = {};
 const props = exportedCommands.reduce((prev, fileName) => {
-  const commandName = fileName.substring(fileName.lastIndexOf('/')+1).replace('.js', '');
+  const commandName = fileName.substring(fileName.lastIndexOf('/') + 1).replace('.js', '');
   prev[commandName] = {
     configurable: true,
     get: function() {
@@ -29,4 +29,4 @@ const props = exportedCommands.reduce((prev, fileName) => {
 
 Object.defineProperties(Commands, props);
 
-module.exports = Commands;
+module.exports = Commands;
diff --git a/examples/cucumber-js/features/step_definitions/nightwatch.js b/examples/cucumber-js/features/step_definitions/nightwatch.js
@@ -30,4 +30,4 @@ Then(/^the title is "([^"]*)"$/, function(title) {
 
 Then(/^Body contains "([^"]*)"$/, function(contains) {
   return  browser.assert.textContains('.search-results', contains);
-});
+});
diff --git a/examples/custom-commands/strictClick.js b/examples/custom-commands/strictClick.js
@@ -3,4 +3,4 @@ module.exports = {
     return this.waitForElementVisible(selector)
       .click(selector);
   }
-};
+};
diff --git a/examples/pages/google/search.js b/examples/pages/google/search.js
@@ -2,7 +2,7 @@ const searchCommands = {
   submit() {
     this.waitForElementVisible('@submitButton', 1000)
       .click('@submitButton');
-    
+
     this.pause(1000);
 
     return this; // Return page object for chaining

diff --git a/examples/pages/google/searchResults.js b/examples/pages/google/searchResults.js
@@ -6,7 +6,7 @@ const menuCommands = {
     var self = this;
 
     return this.getAttribute(product, 'class', function (result) {
-      let isSelected = result.value.indexOf('hdtb-msel') > -1;
+      const isSelected = result.value.indexOf('hdtb-msel') > -1;
       callback.call(self, isSelected);
     });
   }
@@ -44,4 +44,4 @@ module.exports = {
       }
     }
   }
-};
+};
diff --git a/examples/tests/chromeCDP_example.js b/examples/tests/chromeCDP_example.js
@@ -1,7 +1,7 @@
 describe('Chrome DevTools Example', function() {
 
   this.disabled = this.argv.env !== 'chrome';
-  
+
   it ('using CDP DOM Snapshot', async function(browser) {
     await browser.navigateTo('https://nightwatchjs.org');
 
@@ -11,4 +11,4 @@ describe('Chrome DevTools Example', function() {
 
     browser.assert.deepStrictEqual(Object.keys(dom), ['documents', 'strings']);
   });
-});
+});
diff --git a/examples/tests/duckDuckGo.js b/examples/tests/duckDuckGo.js
@@ -11,5 +11,5 @@ describe('duckduckgo example', function() {
       .assert.visible('button[type=submit]')
       .click('button[type=submit]')
       .assert.textContains('.react-results--main', 'Nightwatch.js');
-  }); 
+  });
 });
diff --git a/examples/tests/element/elementapi-tests.js b/examples/tests/element/elementapi-tests.js
@@ -79,4 +79,4 @@ describe('queries tests', function() {
   });
 
 
-});
+});
diff --git a/examples/tests/sample-with-relative-locators.js b/examples/tests/sample-with-relative-locators.js
@@ -22,4 +22,4 @@ describe('sample with relative locators', function () {
   });
 
   after(browser => browser.end());
-});
+});
diff --git a/examples/tests/selectElement.js b/examples/tests/selectElement.js
@@ -13,4 +13,4 @@ module.exports = {
       })
       .assert.selected(await selectElement.findElement('option[value=four]'), 'Forth option is selected');
   }
-};
+};
diff --git a/examples/tests/shadowRootExample.js b/examples/tests/shadowRootExample.js
@@ -50,4 +50,4 @@ describe('Shadow Root example test', function() {
     // await expect.element(firstElement).to.be.an('img');
 
   });
-});
+});
diff --git a/examples/unittests/testUtils.js b/examples/unittests/testUtils.js
@@ -19,4 +19,4 @@ module.exports = {
     assert.strictEqual(Utils.getTestSuiteName('test.case.one'), 'Test Case One');
     assert.strictEqual(Utils.getTestSuiteName('testCaseOne'), 'Test Case One');
   }
-};
+};
diff --git a/examples/unittests/testUtilsWithChai.js b/examples/unittests/testUtilsWithChai.js
@@ -16,4 +16,4 @@ module.exports = {
     var resultMs = Utils.formatElapsedTime(999);
     expect(resultMs).to.equal('999ms');
   }
-};
+};
diff --git a/lib/api/_loaders/_base-loader.js b/lib/api/_loaders/_base-loader.js
@@ -399,20 +399,20 @@ class BaseLoader extends EventEmitter {
       const options = this.getCommandOptions();
 
 
-      if (args && args.length > 0 && Utils.isFunction(args[args.length-1])) {
+      if (args && args.length > 0 && Utils.isFunction(args[args.length - 1])) {
         const callback = args.pop();
-        
+
         const userCallbackWrapper = (function(context) {
-          
+
           const proxyFn = new Proxy(callback, {
             apply: function(target, thisArg, argumentsList) {
               context.addedInsideCallback = true;
-          
+
               return target.apply(thisArg, argumentsList);
             }
           });
           proxyFn.originalTarget = callback;
-          
+
           return  proxyFn;
         })(this);
 

diff --git a/lib/api/_loaders/command.js b/lib/api/_loaders/command.js
@@ -42,7 +42,7 @@ class CommandLoader extends BaseCommandLoader {
         return function(...args) {
           let callback;
           let method;
-          const isLastArgFunction = isFunction(args[args.length-1]);
+          const isLastArgFunction = isFunction(args[args.length - 1]);
 
           if (isLastArgFunction) {
             callback = args.pop();
@@ -74,8 +74,8 @@ class CommandLoader extends BaseCommandLoader {
       reportProtocolErrors(result) {
         if (opts.isUserDefined) {
           return true;
-        } 
-        
+        }
+
         return super.reportProtocolErrors(result);
       }
 
@@ -85,11 +85,11 @@ class CommandLoader extends BaseCommandLoader {
 
       get reuseBrowser() {
         return nightwatchInstance.argv['reuse-browser'] || (nightwatchInstance.settings.globals && nightwatchInstance.settings.globals.reuseBrowserSession);
-      }      
-      
+      }
+
       get isES6AsyncCommand() {
         return isES6AsyncFn(
-          CommandLoader.isDeprecatedCommandStyle(CommandModule) ? CommandModule.command: this.command
+          CommandLoader.isDeprecatedCommandStyle(CommandModule) ? CommandModule.command : this.command
         );
       }
 
@@ -210,7 +210,7 @@ class CommandLoader extends BaseCommandLoader {
               if (result.stack) {
                 err.stack = result.stack;
               }
-              
+
               if (result.error instanceof Error) {
                 result.error.registered = true;
               } else {

diff --git a/lib/api/_loaders/element-global.js b/lib/api/_loaders/element-global.js
@@ -161,7 +161,7 @@ class ElementGlobal {
         value = {
           value: locator,
           using: this.client.locateStrategy
-        };  
+        };
       } else {
         value = locator;
       }
@@ -267,7 +267,7 @@ class ElementGlobal {
           });
         }
 
-        const lastArg = args[args.length-1];
+        const lastArg = args[args.length - 1];
         if (isFunction(lastArg)) {
           if (error) {
             return lastArg.call(this.api, {

diff --git a/lib/api/_loaders/expect.js b/lib/api/_loaders/expect.js
@@ -115,7 +115,7 @@ class ExpectLoader extends BaseCommandLoader {
           deferred.reject(err);
         });
       }
-      
+
       return expectCommand.instance;
     }.bind(this));
   }

diff --git a/lib/api/_loaders/static.js b/lib/api/_loaders/static.js
@@ -182,7 +182,7 @@ module.exports = class StaticAssert {
 
         Object.assign(node.deferred.promise, apiToReturn || this.api);
 
-        //prevent unhandled rejection        
+        //prevent unhandled rejection
         node.deferred.promise.catch(err => {
           return StaticAssert.lastDeferred.reject(err);
         });

diff --git a/lib/api/assertions/_assertionInstance.js b/lib/api/assertions/_assertionInstance.js
@@ -21,7 +21,7 @@ class AssertionInstance {
   }
 
   static init({nightwatchInstance, args, fileName, options}) {
-    if (Utils.isFunction(args[args.length-1])) {
+    if (Utils.isFunction(args[args.length - 1])) {
       this.__doneCallback = args.pop();
     } else {
       this.__doneCallback = function(result) {

diff --git a/lib/api/assertions/domPropertyMatches.js b/lib/api/assertions/domPropertyMatches.js
@@ -1,12 +1,12 @@
 /**
  * Check if specified DOM property value of a given element matches a regex. For all the available DOM element properties, consult the [Element doc at MDN](https://developer.mozilla.org/en-US/docs/Web/API/element).
- * 
- * 
+ *
+ *
  * @example
  * this.demoTest = function (browser) {
  *   browser.assert.domPropertyMatches('#main', 'tagName', /^frame/);
  * }
- * 
+ *
  * @method assert.domPropertyMatches
  * @param {string|object} definition The selector (CSS/Xpath) used to locate the element. Can either be a string or an object which specifies [element properties](https://nightwatchjs.org/guide#element-properties).
  * @param {string} domProperty The DOM property name.
@@ -41,10 +41,10 @@ exports.assertion = function (definition, domProperty, regexExpression, msg) {
 
     if (!Array.isArray(value)) {
       return regex.test(value);
-    } 
+    }
 
     return false;
-  }; 
+  };
 
   this.value = function(result = {}) {
     return result.value || '';

diff --git a/lib/api/assertions/elementsCount.js b/lib/api/assertions/elementsCount.js
@@ -50,7 +50,7 @@ exports.assertion = function (definition, count, msg) {
 
 
   this.command = async function(callback) {
-  
+
     await this.api.findElements(definition, callback);
   };
 };
diff --git a/lib/api/assertions/enabled.js b/lib/api/assertions/enabled.js
@@ -21,7 +21,7 @@ exports.assertion = function(definition, msg) {
 
   this.formatMessage = function() {
     const message = msg || `Testing if element %s ${this.negate ? 'is not enabled' : 'is enabled'}`;
-    
+
     return {
       message,
       args: [this.elementSelector]
@@ -43,5 +43,5 @@ exports.assertion = function(definition, msg) {
   this.command = function(callback) {
     this.api.isEnabled(definition, callback);
   };
-  
+
 };