Build Nightwatch using TypeScript. (nightwatchjs#3774)

* Setup TypeScript.

* Add prepublishOnly script.

* Copy .ejs file after ts build.

* Add dev and mocha scripts.

* Update CONTRIBUTING.md

* Directly import methods from Utils.

* Use ts-node for dev runs.

Author: garg3133

.eslintignore

@@ -3,3 +3,4 @@ package.json
 *.json
 lib/utils/requireModule.js
 lib/reporter/reporters/html
+dist

.github/CONTRIBUTING.md

@@ -33,16 +33,21 @@ Feature requests are welcome.
 ## Submitting a pull request
 Thanks in advance for your contribution.
 
-1. Follow the usual git workflow for submitting a pull request
-  
-  * fork the project
-  * create a new branch from master (e.g. `features/my-new-feature` or `issue/123-my-bugfix`)
-2. If you're fixing a bug also create an issue if one doesn't exist yet
-3. If it's a new feature/enhancemnt explain why do you think it's necessary
-4. If your change include drastic or low level changes please discuss them to make sure they will be accepted and what the impact will be
-5. If your change is based on exisiting functionality please consider refactoring first. Pull requests that duplicate code will not make it in very quick, if at all
-6. Do not include changes that are not related to the issue at hand
+1. Follow the usual git workflow for submitting a pull request:
+   * fork the project
+   * create a new branch from main (e.g. `features/my-new-feature` or `issue/123-my-bugfix`)
+   * add your changes
+   * try to run some Nightwatch tests locally to test the functionality after making your changes: `npm run dev -- examples/tests/ecosia.js --env chrome`
+   * run Nightwatch unit tests locally: `npm test`  
+     or, run individual tests: `npm run mocha -- test/src/api/commands/client/testWaitUntil.js`
+   * commit your changes and create a pull request
+
+2. If you're fixing a bug, also create an issue if one doesn't exist yet.
+3. If it's a new feature/enhancement, explain why do you think it's necessary.
+4. If your change include drastic or low level changes please discuss them to make sure they will be accepted and what the impact will be.
+5. If your change is based on existing functionality, please consider refactoring first. Pull requests that duplicate code will not make it in very quick, if at all.
+6. Do not include changes that are not related to the issue at hand.
 6. Follow the same coding style with regards to spaces, semicolons, variable naming etc. 
-7. Always add tests - after all this _is_ a testing framework
+7. Always add tests - after all this _is_ a testing framework.
 
 

.gitignore

@@ -8,6 +8,7 @@
 /nightwatch.json
 /nightwatch.conf.js
 node_modules
+dist
 npm-debug.log
 lib-cov
 coverage.html

api/index.js

@@ -13,7 +13,7 @@ const exportedCommands = [
   'protocol/quit.js'
 ];
 
-const basePath = '../lib/api';
+const basePath = '../dist/api';
 const Commands = {};
 const props = exportedCommands.reduce((prev, fileName) => {
   const commandName = fileName.substring(fileName.lastIndexOf('/')+1).replace('.js', '');

bin/nightwatch

@@ -1,7 +1,11 @@
 #!/usr/bin/env node
 
+const utilsPath = process.env.NIGHTWATCH_TS_NODE_DEV ?
+  '../lib/utils' :
+  '../dist/utils';
+
 const semver = require('semver');
-const {Logger} = require('../lib/utils');
+const {Logger} = require(utilsPath);
 const requiredVersion = require('../package.json').engines.node;
 
 function checkNodeVersion (wanted, id) {

bin/runner.js

@@ -1,8 +1,10 @@
 /**
  * Module dependencies
  */
-const Nightwatch = require('../lib/index.js');
-const {Logger, shouldReplaceStack, alwaysDisplayError} = require('../lib/utils');
+const mainDir = process.env.NIGHTWATCH_TS_NODE_DEV ? 'lib' : 'dist';
+
+const Nightwatch = require(`../${mainDir}/index.js`);
+const {Logger, shouldReplaceStack, alwaysDisplayError} = require(`../${mainDir}/utils`);
 
 try {
   Nightwatch.cli(function (argv) {

cucumber-js/_setup_cucumber_runner.js

@@ -1,4 +1,8 @@
-const Nightwatch = require('../lib');
+const nightwatchMain = process.env.NIGHTWATCH_TS_NODE_DEV ?
+  '../lib' :
+  '../dist';
+
+const Nightwatch = require(nightwatchMain);
 const {Before, After, setDefaultTimeout} = require('@cucumber/cucumber');
 
 setDefaultTimeout(-1);

examples/unittests/testUtils.js

@@ -1,5 +1,5 @@
 const assert = require('assert');
-const Utils = require('../../lib/utils/');
+const Utils = require('../../dist/utils/');
 
 module.exports = {
   testFormatElapsedTime: function() {

examples/unittests/testUtilsWithChai.js

@@ -1,4 +1,4 @@
-const Utils = require('../../lib/utils/');
+const Utils = require('../../dist/utils/');
 const expect = require('chai').expect;
 
 module.exports = {

index.js

@@ -1,3 +1,3 @@
 module.exports = process.env.NIGHTWATCH_COV ?
   require('./lib-cov/index') :
-  require('./lib/index');
+  require('./dist/index');

lib/api/_loaders/command.js

@@ -1,7 +1,6 @@
 const EventEmitter = require('events');
 const BaseCommandLoader = require('./_command-loader.js');
-const Utils = require('../../utils');
-const {Logger} = require('../../../lib/utils');
+const {Logger, isES6AsyncFn, isFunction, isObject, makePromise} = require('../../utils');
 
 class CommandLoader extends BaseCommandLoader {
 
@@ -12,7 +11,7 @@ class CommandLoader extends BaseCommandLoader {
   }
 
   static isDeprecatedCommandStyle(CommandModule) {
-    return Utils.isObject(CommandModule) && Utils.isFunction(CommandModule.command);
+    return isObject(CommandModule) && isFunction(CommandModule.command);
   }
 
   /**
@@ -24,7 +23,7 @@ class CommandLoader extends BaseCommandLoader {
   static createFromObject(CommandModule) {
     return class CommandClass extends EventEmitter {
       command(...args) {
-        if (Utils.isES6AsyncFn(CommandModule.command)) {
+        if (isES6AsyncFn(CommandModule.command)) {
           return CommandModule.command.apply(this.api, args);
         }
 
@@ -43,7 +42,7 @@ class CommandLoader extends BaseCommandLoader {
         return function(...args) {
           let callback;
           let method;
-          let isLastArgFunction = Utils.isFunction(args[args.length-1]);
+          const isLastArgFunction = isFunction(args[args.length-1]);
 
           if (isLastArgFunction) {
             callback = args.pop();
@@ -62,7 +61,7 @@ class CommandLoader extends BaseCommandLoader {
             method = target[name];
           }
 
-          return method(definition).then((result) => Utils.makePromise(callback, api, [result]));
+          return method(definition).then((result) => makePromise(callback, api, [result]));
         };
       }
     });
@@ -89,7 +88,7 @@ class CommandLoader extends BaseCommandLoader {
       }      
 
       get isES6AsyncCommand() {
-        return Utils.isES6AsyncFn(
+        return isES6AsyncFn(
           CommandLoader.isDeprecatedCommandStyle(CommandModule) ? CommandModule.command: this.command
         );
       }
@@ -123,7 +122,7 @@ class CommandLoader extends BaseCommandLoader {
       }
 
       complete(...args) {
-        if (Utils.isFunction(super.complete)) {
+        if (isFunction(super.complete)) {
           return super.complete(...args);
         }
 
@@ -134,7 +133,7 @@ class CommandLoader extends BaseCommandLoader {
     const instance = new CommandInstance();
 
     Object.keys(CommandLoader.interfaceMethods).forEach(method => {
-      let type = CommandLoader.interfaceMethods[method];
+      const type = CommandLoader.interfaceMethods[method];
       if (!BaseCommandLoader.isTypeImplemented(instance, method, type)) {
         throw new Error(`Command class must implement method .${method}()`);
       }
@@ -167,7 +166,7 @@ class CommandLoader extends BaseCommandLoader {
         }
 
         if (instance.w3c_deprecated) {
-          let extraMessage = instance.deprecationNotice ? `\n  ${instance.deprecationNotice}` : '';
+          const extraMessage = instance.deprecationNotice ? `\n  ${instance.deprecationNotice}` : '';
           // eslint-disable-next-line no-console
           console.warn(`This command has been deprecated and is removed from the W3C Webdriver standard. It is only working with legacy Selenium JSONWire protocol.${extraMessage}`);
         }
@@ -198,15 +197,15 @@ class CommandLoader extends BaseCommandLoader {
           })
           .then(result => {
             let reportErrors = instance.client.settings.report_command_errors;
-            let reportNetworkErrors = instance.client.settings.report_network_errors;
+            const reportNetworkErrors = instance.client.settings.report_network_errors;
 
             if (result && result.error && result.error.code && result.status === -1 && reportNetworkErrors) {
               // node.js errors, e.g. ECONNRESET
               reportErrors = true;
             }
 
             if (result && result.status === -1 && instance.reportProtocolErrors(result) && reportErrors) {
-              let err = new Error(`Error while running .${this.commandName}(): ${result.error}`);
+              const err = new Error(`Error while running .${this.commandName}(): ${result.error}`);
 
               if (result.stack) {
                 err.stack = result.stack;

lib/index.d.ts

@@ -368,19 +368,6 @@ function throwIfBrowserNotAvailable() {
   }
 }
 
-const globalBrowserDescriptor = {
-  configurable: true,
-  get() {
-    throwIfBrowserNotAvailable();
-
-    return global.browser;
-  }
-};
-
-Object.defineProperty(Nightwatch, 'browser', globalBrowserDescriptor);
-
-Object.defineProperty(Nightwatch, 'app', globalBrowserDescriptor);
-
 Object.defineProperty(Nightwatch, 'Key', {
   configurable: true,
   get() {
@@ -401,7 +388,7 @@ const {
   chrome, firefox, assert, verify, expect, element
 } = namespacedApi;
 
-// browser and app are overwritten above using `Object.defineProperty()`.
+// browser and app are overwritten below using `Object.defineProperty()`.
 module.exports.browser = browser;
 module.exports.app = app;
 
@@ -449,3 +436,14 @@ module.exports.element = new Proxy(element, {
     return global.browser.element[name];
   }
 });
+
+const globalBrowserDescriptor = {
+  configurable: true,
+  get() {
+    throwIfBrowserNotAvailable();
+
+    return global.browser;
+  }
+};
+Object.defineProperty(Nightwatch, 'browser', globalBrowserDescriptor);
+Object.defineProperty(Nightwatch, 'app', globalBrowserDescriptor);