mocha 5.0.4 → 5.2.0

package/lib/context.js

@@ -1,5 +1,7 @@
 'use strict';
-
+/**
+ * @module Context
+ */
 /**
  * Expose `Context`.
  */
@@ -11,16 +13,16 @@ module.exports = Context;
  *
  * @api private
  */
-function Context () {}
+function Context() {}
 
 /**
  * Set or get the context `Runnable` to `runnable`.
  *
  * @api private
  * @param {Runnable} runnable
- * @return {Context}
+ * @return {Context} context
  */
-Context.prototype.runnable = function (runnable) {
+Context.prototype.runnable = function(runnable) {
   if (!arguments.length) {
     return this._runnable;
   }
@@ -35,7 +37,7 @@ Context.prototype.runnable = function (runnable) {
  * @param {number} ms
  * @return {Context} self
  */
-Context.prototype.timeout = function (ms) {
+Context.prototype.timeout = function(ms) {
   if (!arguments.length) {
     return this.runnable().timeout();
   }
@@ -50,7 +52,7 @@ Context.prototype.timeout = function (ms) {
  * @param {boolean} enabled
  * @return {Context} self
  */
-Context.prototype.enableTimeouts = function (enabled) {
+Context.prototype.enableTimeouts = function(enabled) {
   if (!arguments.length) {
     return this.runnable().enableTimeouts();
   }
@@ -65,7 +67,7 @@ Context.prototype.enableTimeouts = function (enabled) {
  * @param {number} ms
  * @return {Context} self
  */
-Context.prototype.slow = function (ms) {
+Context.prototype.slow = function(ms) {
   if (!arguments.length) {
     return this.runnable().slow();
   }
@@ -79,7 +81,7 @@ Context.prototype.slow = function (ms) {
  * @api private
  * @throws Pending
  */
-Context.prototype.skip = function () {
+Context.prototype.skip = function() {
   this.runnable().skip();
 };
 
@@ -90,7 +92,7 @@ Context.prototype.skip = function () {
  * @param {number} n
  * @return {Context} self
  */
-Context.prototype.retries = function (n) {
+Context.prototype.retries = function(n) {
   if (!arguments.length) {
     return this.runnable().retries();
   }

package/lib/hook.js

@@ -1,9 +1,5 @@
 'use strict';
 
-/**
- * Module dependencies.
- */
-
 var Runnable = require('./runnable');
 var inherits = require('./utils').inherits;
 
@@ -14,13 +10,14 @@ var inherits = require('./utils').inherits;
 module.exports = Hook;
 
 /**
- * Initialize a new `Hook` with the given `title` and callback `fn`.
+ * Initialize a new `Hook` with the given `title` and callback `fn`
  *
+ * @class
+ * @extends Runnable
  * @param {String} title
  * @param {Function} fn
- * @api private
  */
-function Hook (title, fn) {
+function Hook(title, fn) {
   Runnable.call(this, title, fn);
   this.type = 'hook';
 }
@@ -33,11 +30,12 @@ inherits(Hook, Runnable);
 /**
  * Get or set the test `err`.
  *
+ * @memberof Hook
+ * @public
  * @param {Error} err
  * @return {Error}
- * @api public
  */
-Hook.prototype.error = function (err) {
+Hook.prototype.error = function(err) {
   if (!arguments.length) {
     err = this._error;
     this._error = null;

package/lib/interfaces/bdd.js

@@ -1,9 +1,5 @@
 'use strict';
 
-/**
- * Module dependencies.
- */
-
 var Test = require('../test');
 
 /**
@@ -23,10 +19,10 @@ var Test = require('../test');
  *
  * @param {Suite} suite Root suite.
  */
-module.exports = function (suite) {
+module.exports = function bddInterface(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function (context, file, mocha) {
+  suite.on('pre-require', function(context, file, mocha) {
     var common = require('./common')(suites, context, mocha);
 
     context.before = common.before;
@@ -40,7 +36,7 @@ module.exports = function (suite) {
      * and/or tests.
      */
 
-    context.describe = context.context = function (title, fn) {
+    context.describe = context.context = function(title, fn) {
       return common.suite.create({
         title: title,
         file: file,
@@ -52,7 +48,10 @@ module.exports = function (suite) {
      * Pending describe.
      */
 
-    context.xdescribe = context.xcontext = context.describe.skip = function (title, fn) {
+    context.xdescribe = context.xcontext = context.describe.skip = function(
+      title,
+      fn
+    ) {
       return common.suite.skip({
         title: title,
         file: file,
@@ -64,7 +63,7 @@ module.exports = function (suite) {
      * Exclusive suite.
      */
 
-    context.describe.only = function (title, fn) {
+    context.describe.only = function(title, fn) {
       return common.suite.only({
         title: title,
         file: file,
@@ -78,7 +77,7 @@ module.exports = function (suite) {
      * acting as a thunk.
      */
 
-    context.it = context.specify = function (title, fn) {
+    context.it = context.specify = function(title, fn) {
       var suite = suites[0];
       if (suite.isPending()) {
         fn = null;
@@ -93,7 +92,7 @@ module.exports = function (suite) {
      * Exclusive test-case.
      */
 
-    context.it.only = function (title, fn) {
+    context.it.only = function(title, fn) {
       return common.test.only(mocha, context.it(title, fn));
     };
 
@@ -101,14 +100,14 @@ module.exports = function (suite) {
      * Pending test case.
      */
 
-    context.xit = context.xspecify = context.it.skip = function (title) {
+    context.xit = context.xspecify = context.it.skip = function(title) {
       return context.it(title);
     };
 
     /**
      * Number of attempts to retry.
      */
-    context.it.retries = function (n) {
+    context.it.retries = function(n) {
       context.retries(n);
     };
   });

package/lib/interfaces/common.js

@@ -10,7 +10,7 @@ var Suite = require('../suite');
  * @param {Mocha} mocha
  * @return {Object} An object containing common functions.
  */
-module.exports = function (suites, context, mocha) {
+module.exports = function(suites, context, mocha) {
   return {
     /**
      * This is only present if flag --delay is passed into Mocha. It triggers
@@ -19,8 +19,8 @@ module.exports = function (suites, context, mocha) {
      * @param {Suite} suite The root suite.
      * @return {Function} A function which runs the root suite
      */
-    runWithSuite: function runWithSuite (suite) {
-      return function run () {
+    runWithSuite: function runWithSuite(suite) {
+      return function run() {
         suite.run();
       };
     },
@@ -31,7 +31,7 @@ module.exports = function (suites, context, mocha) {
      * @param {string} name
      * @param {Function} fn
      */
-    before: function (name, fn) {
+    before: function(name, fn) {
       suites[0].beforeAll(name, fn);
     },
 
@@ -41,7 +41,7 @@ module.exports = function (suites, context, mocha) {
      * @param {string} name
      * @param {Function} fn
      */
-    after: function (name, fn) {
+    after: function(name, fn) {
       suites[0].afterAll(name, fn);
     },
 
@@ -51,7 +51,7 @@ module.exports = function (suites, context, mocha) {
      * @param {string} name
      * @param {Function} fn
      */
-    beforeEach: function (name, fn) {
+    beforeEach: function(name, fn) {
       suites[0].beforeEach(name, fn);
     },
 
@@ -61,7 +61,7 @@ module.exports = function (suites, context, mocha) {
      * @param {string} name
      * @param {Function} fn
      */
-    afterEach: function (name, fn) {
+    afterEach: function(name, fn) {
       suites[0].afterEach(name, fn);
     },
 
@@ -73,7 +73,7 @@ module.exports = function (suites, context, mocha) {
        * @param {Object} opts
        * @returns {Suite}
        */
-      only: function only (opts) {
+      only: function only(opts) {
         opts.isOnly = true;
         return this.create(opts);
       },
@@ -85,7 +85,7 @@ module.exports = function (suites, context, mocha) {
        * @param {Object} opts
        * @returns {Suite}
        */
-      skip: function skip (opts) {
+      skip: function skip(opts) {
         opts.pending = true;
         return this.create(opts);
       },
@@ -100,7 +100,7 @@ module.exports = function (suites, context, mocha) {
        * @param {boolean} [opts.isOnly] Is Suite exclusive?
        * @returns {Suite}
        */
-      create: function create (opts) {
+      create: function create(opts) {
         var suite = Suite.create(suites[0], opts.title);
         suite.pending = Boolean(opts.pending);
         suite.file = opts.file;
@@ -112,7 +112,13 @@ module.exports = function (suites, context, mocha) {
           opts.fn.call(suite);
           suites.shift();
         } else if (typeof opts.fn === 'undefined' && !suite.pending) {
-          throw new Error('Suite "' + suite.fullTitle() + '" was defined but no callback was supplied. Supply a callback or explicitly skip the suite.');
+          throw new Error(
+            'Suite "' +
+              suite.fullTitle() +
+              '" was defined but no callback was supplied. Supply a callback or explicitly skip the suite.'
+          );
+        } else if (!opts.fn && suite.pending) {
+          suites.shift();
         }
 
         return suite;
@@ -120,7 +126,6 @@ module.exports = function (suites, context, mocha) {
     },
 
     test: {
-
       /**
        * Exclusive test-case.
        *
@@ -128,7 +133,7 @@ module.exports = function (suites, context, mocha) {
        * @param {Function} test
        * @returns {*}
        */
-      only: function (mocha, test) {
+      only: function(mocha, test) {
         test.parent._onlyTests = test.parent._onlyTests.concat(test);
         return test;
       },
@@ -138,7 +143,7 @@ module.exports = function (suites, context, mocha) {
        *
        * @param {string} title
        */
-      skip: function (title) {
+      skip: function(title) {
         context.test(title);
       },
 
@@ -147,7 +152,7 @@ module.exports = function (suites, context, mocha) {
        *
        * @param {number} n
        */
-      retries: function (n) {
+      retries: function(n) {
         context.retries(n);
       }
     }

package/lib/interfaces/exports.js

@@ -1,9 +1,4 @@
 'use strict';
-
-/**
- * Module dependencies.
- */
-
 var Suite = require('../suite');
 var Test = require('../test');
 
@@ -24,12 +19,12 @@ var Test = require('../test');
  *
  * @param {Suite} suite Root suite.
  */
-module.exports = function (suite) {
+module.exports = function(suite) {
   var suites = [suite];
 
   suite.on('require', visit);
 
-  function visit (obj, file) {
+  function visit(obj, file) {
     var suite;
     for (var key in obj) {
       if (typeof obj[key] === 'function') {

package/lib/interfaces/qunit.js

@@ -1,9 +1,5 @@
 'use strict';
 
-/**
- * Module dependencies.
- */
-
 var Test = require('../test');
 
 /**
@@ -31,10 +27,10 @@ var Test = require('../test');
  *
  * @param {Suite} suite Root suite.
  */
-module.exports = function (suite) {
+module.exports = function qUnitInterface(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function (context, file, mocha) {
+  suite.on('pre-require', function(context, file, mocha) {
     var common = require('./common')(suites, context, mocha);
 
     context.before = common.before;
@@ -46,7 +42,7 @@ module.exports = function (suite) {
      * Describe a "suite" with the given `title`.
      */
 
-    context.suite = function (title) {
+    context.suite = function(title) {
       if (suites.length > 1) {
         suites.shift();
       }
@@ -61,7 +57,7 @@ module.exports = function (suite) {
      * Exclusive Suite.
      */
 
-    context.suite.only = function (title) {
+    context.suite.only = function(title) {
       if (suites.length > 1) {
         suites.shift();
       }
@@ -78,7 +74,7 @@ module.exports = function (suite) {
      * acting as a thunk.
      */
 
-    context.test = function (title, fn) {
+    context.test = function(title, fn) {
       var test = new Test(title, fn);
       test.file = file;
       suites[0].addTest(test);
@@ -89,7 +85,7 @@ module.exports = function (suite) {
      * Exclusive test-case.
      */
 
-    context.test.only = function (title, fn) {
+    context.test.only = function(title, fn) {
       return common.test.only(mocha, context.test(title, fn));
     };
 

package/lib/interfaces/tdd.js

@@ -1,9 +1,5 @@
 'use strict';
 
-/**
- * Module dependencies.
- */
-
 var Test = require('../test');
 
 /**
@@ -31,10 +27,10 @@ var Test = require('../test');
  *
  * @param {Suite} suite Root suite.
  */
-module.exports = function (suite) {
+module.exports = function(suite) {
   var suites = [suite];
 
-  suite.on('pre-require', function (context, file, mocha) {
+  suite.on('pre-require', function(context, file, mocha) {
     var common = require('./common')(suites, context, mocha);
 
     context.setup = common.beforeEach;
@@ -47,7 +43,7 @@ module.exports = function (suite) {
      * Describe a "suite" with the given `title` and callback `fn` containing
      * nested suites and/or tests.
      */
-    context.suite = function (title, fn) {
+    context.suite = function(title, fn) {
       return common.suite.create({
         title: title,
         file: file,
@@ -58,7 +54,7 @@ module.exports = function (suite) {
     /**
      * Pending suite.
      */
-    context.suite.skip = function (title, fn) {
+    context.suite.skip = function(title, fn) {
       return common.suite.skip({
         title: title,
         file: file,
@@ -69,7 +65,7 @@ module.exports = function (suite) {
     /**
      * Exclusive test-case.
      */
-    context.suite.only = function (title, fn) {
+    context.suite.only = function(title, fn) {
       return common.suite.only({
         title: title,
         file: file,
@@ -81,7 +77,7 @@ module.exports = function (suite) {
      * Describe a specification or test-case with the given `title` and
      * callback `fn` acting as a thunk.
      */
-    context.test = function (title, fn) {
+    context.test = function(title, fn) {
       var suite = suites[0];
       if (suite.isPending()) {
         fn = null;
@@ -96,7 +92,7 @@ module.exports = function (suite) {
      * Exclusive test-case.
      */
 
-    context.test.only = function (title, fn) {
+    context.test.only = function(title, fn) {
       return common.test.only(mocha, context.test(title, fn));
     };