fixed type definitions

Author: DavertMik

lib/listener/steps.js

@@ -1,88 +1,88 @@
-const debug = require('debug')('codeceptjs:steps');
-const event = require('../event');
-const store = require('../store');
-const output = require('../output');
-const { BeforeHook, AfterHook, BeforeSuiteHook, AfterSuiteHook } = require('../mocha/hooks');
+const debug = require('debug')('codeceptjs:steps')
+const event = require('../event')
+const store = require('../store')
+const output = require('../output')
+const { BeforeHook, AfterHook, BeforeSuiteHook, AfterSuiteHook } = require('../mocha/hooks')
 
-let currentTest;
-let currentHook;
+let currentTest
+let currentHook
 
 /**
  * Register steps inside tests
  */
 module.exports = function () {
   event.dispatcher.on(event.test.before, test => {
-    test.startedAt = +new Date();
-    test.artifacts = {};
-  });
+    test.startedAt = +new Date()
+    test.artifacts = {}
+  })
 
   event.dispatcher.on(event.test.started, test => {
-    currentTest = test;
-    currentTest.steps = [];
-    if (!('retryNum' in currentTest)) currentTest.retryNum = 0;
-    else currentTest.retryNum += 1;
-    output.scenario.started(test);
-  });
+    currentTest = test
+    currentTest.steps = []
+    if (!('retryNum' in currentTest)) currentTest.retryNum = 0
+    else currentTest.retryNum += 1
+    output.scenario.started(test)
+  })
 
   event.dispatcher.on(event.test.after, test => {
-    currentTest = null;
-  });
+    currentTest = null
+  })
 
-  event.dispatcher.on(event.test.finished, test => {});
+  event.dispatcher.on(event.test.finished, test => {})
 
   event.dispatcher.on(event.hook.started, hook => {
-    currentHook = hook.ctx.test;
-    currentHook.steps = [];
+    currentHook = hook.ctx.test
+    currentHook.steps = []
 
-    output.hook.started(hook);
+    output.hook.started(hook)
 
-    if (hook.ctx && hook.ctx.test) output.log(`--- STARTED ${hook.ctx.test.title} ---`);
-  });
+    if (hook.ctx && hook.ctx.test) debug(`--- STARTED ${hook.ctx.test.title} ---`)
+  })
 
   event.dispatcher.on(event.hook.passed, hook => {
-    currentHook = null;
-    output.hook.passed(hook);
-    if (hook.ctx && hook.ctx.test) output.log(`--- ENDED ${hook.ctx.test.title} ---`);
-  });
+    currentHook = null
+    output.hook.passed(hook)
+    if (hook.ctx && hook.ctx.test) debug(`--- ENDED ${hook.ctx.test.title} ---`)
+  })
 
   event.dispatcher.on(event.test.failed, () => {
     const cutSteps = function (current) {
-      const failureIndex = current.steps.findIndex(el => el.status === 'failed');
+      const failureIndex = current.steps.findIndex(el => el.status === 'failed')
       // To be sure that failed test will be failed in report
-      current.state = 'failed';
-      current.steps.length = failureIndex + 1;
-      return current;
-    };
+      current.state = 'failed'
+      current.steps.length = failureIndex + 1
+      return current
+    }
     if (currentHook && Array.isArray(currentHook.steps) && currentHook.steps.length) {
-      currentHook = cutSteps(currentHook);
-      return (currentHook = null);
+      currentHook = cutSteps(currentHook)
+      return (currentHook = null)
     }
-    if (!currentTest) return;
+    if (!currentTest) return
     // last step is failing step
-    if (!currentTest.steps.length) return;
-    return (currentTest = cutSteps(currentTest));
-  });
+    if (!currentTest.steps.length) return
+    return (currentTest = cutSteps(currentTest))
+  })
 
   event.dispatcher.on(event.test.passed, () => {
-    if (!currentTest) return;
+    if (!currentTest) return
     // To be sure that passed test will be passed in report
-    delete currentTest.err;
-    currentTest.state = 'passed';
-  });
+    delete currentTest.err
+    currentTest.state = 'passed'
+  })
 
   event.dispatcher.on(event.step.started, step => {
-    step.startedAt = +new Date();
-    step.test = currentTest;
+    step.startedAt = +new Date()
+    step.test = currentTest
     if (currentHook && Array.isArray(currentHook.steps)) {
-      return currentHook.steps.push(step);
+      return currentHook.steps.push(step)
     }
-    if (!currentTest || !currentTest.steps) return;
-    currentTest.steps.push(step);
-  });
+    if (!currentTest || !currentTest.steps) return
+    currentTest.steps.push(step)
+  })
 
   event.dispatcher.on(event.step.finished, step => {
-    step.finishedAt = +new Date();
-    if (step.startedAt) step.duration = step.finishedAt - step.startedAt;
-    debug(`Step '${step}' finished; Duration: ${step.duration || 0}ms`);
-  });
-};
+    step.finishedAt = +new Date()
+    if (step.startedAt) step.duration = step.finishedAt - step.startedAt
+    debug(`Step '${step}' finished; Duration: ${step.duration || 0}ms`)
+  })
+}

lib/mocha/featureConfig.js

@@ -31,6 +31,10 @@ class FeatureConfig {
   /**
    * Configures a helper.
    * Helper name can be omitted and values will be applied to first helper.
+   *
+   * @param {string|number} helper
+   * @param {*} obj
+   * @returns {this}
    */
   config(helper, obj) {
     if (!obj) {

lib/mocha/scenarioConfig.js

@@ -12,6 +12,7 @@ class ScenarioConfig {
    * Can pass an Error object or regex matching expected message.
    *
    * @param {*} err
+   * @returns {this}
    */
   throws(err) {
     this.test.throws = err
@@ -23,7 +24,7 @@ class ScenarioConfig {
    * If test passes - throws an error.
    * Can pass an Error object or regex matching expected message.
    *
-   * @param {*} err
+   * @returns {this}
    */
   fails() {
     this.test.throws = new Error()
@@ -34,6 +35,7 @@ class ScenarioConfig {
    * Retry this test for number of times
    *
    * @param {number} retries
+   * @returns {this}
    */
   retry(retries) {
     this.test.retries(retries)
@@ -43,6 +45,7 @@ class ScenarioConfig {
   /**
    * Set timeout for this test
    * @param {number} timeout
+   * @returns {this}
    */
   timeout(timeout) {
     this.test.timeout(timeout)
@@ -52,6 +55,7 @@ class ScenarioConfig {
   /**
    * Pass in additional objects to inject into test
    * @param {*} obj
+   * @returns {this}
    */
   inject(obj) {
     this.test.inject = obj
@@ -61,6 +65,9 @@ class ScenarioConfig {
   /**
    * Configures a helper.
    * Helper name can be omitted and values will be applied to first helper.
+   * @param {string|number} helper
+   * @param {*} obj
+   * @returns {this}
    */
   config(helper, obj) {
     if (!obj) {
@@ -80,6 +87,7 @@ class ScenarioConfig {
   /**
    * Append a tag name to scenario title
    * @param {string} tagName
+   * @returns {this}
    */
   tag(tagName) {
     if (tagName[0] !== '@') tagName = `@${tagName}`