mocha 5.1.1 → 6.0.0

package/lib/reporters/list.js

@@ -8,6 +8,13 @@
 
 var Base = require('./base');
 var inherits = require('../utils').inherits;
+var constants = require('../runner').constants;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_TEST_BEGIN = constants.EVENT_TEST_BEGIN;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
 var color = Base.color;
 var cursor = Base.cursor;
 
@@ -24,46 +31,47 @@ exports = module.exports = List;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
-function List (runner) {
+function List(runner) {
   Base.call(this, runner);
 
   var self = this;
   var n = 0;
 
-  runner.on('start', function () {
+  runner.on(EVENT_RUN_BEGIN, function() {
     console.log();
   });
 
-  runner.on('test', function (test) {
+  runner.on(EVENT_TEST_BEGIN, function(test) {
     process.stdout.write(color('pass', '    ' + test.fullTitle() + ': '));
   });
 
-  runner.on('pending', function (test) {
-    var fmt = color('checkmark', '  -') +
-      color('pending', ' %s');
+  runner.on(EVENT_TEST_PENDING, function(test) {
+    var fmt = color('checkmark', '  -') + color('pending', ' %s');
     console.log(fmt, test.fullTitle());
   });
 
-  runner.on('pass', function (test) {
-    var fmt = color('checkmark', '  ' + Base.symbols.ok) +
+  runner.on(EVENT_TEST_PASS, function(test) {
+    var fmt =
+      color('checkmark', '  ' + Base.symbols.ok) +
       color('pass', ' %s: ') +
       color(test.speed, '%dms');
     cursor.CR();
     console.log(fmt, test.fullTitle(), test.duration);
   });
 
-  runner.on('fail', function (test) {
+  runner.on(EVENT_TEST_FAIL, function(test) {
     cursor.CR();
     console.log(color('fail', '  %d) %s'), ++n, test.fullTitle());
   });
 
-  runner.once('end', self.epilogue.bind(self));
+  runner.once(EVENT_RUN_END, self.epilogue.bind(self));
 }
 
 /**
  * Inherit from `Base.prototype`.
  */
 inherits(List, Base);
+
+List.description = 'like "spec" reporter but flat';

package/lib/reporters/markdown.js

@@ -8,6 +8,11 @@
 
 var Base = require('./base');
 var utils = require('../utils');
+var constants = require('../runner').constants;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
+var EVENT_SUITE_END = constants.EVENT_SUITE_END;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
 
 /**
  * Constants
@@ -28,32 +33,31 @@ exports = module.exports = Markdown;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
-function Markdown (runner) {
+function Markdown(runner) {
   Base.call(this, runner);
 
   var level = 0;
   var buf = '';
 
-  function title (str) {
+  function title(str) {
     return Array(level).join('#') + ' ' + str;
   }
 
-  function mapTOC (suite, obj) {
+  function mapTOC(suite, obj) {
     var ret = obj;
     var key = SUITE_PREFIX + suite.title;
 
-    obj = obj[key] = obj[key] || { suite: suite };
-    suite.suites.forEach(function (suite) {
+    obj = obj[key] = obj[key] || {suite: suite};
+    suite.suites.forEach(function(suite) {
       mapTOC(suite, obj);
     });
 
     return ret;
   }
 
-  function stringifyTOC (obj, level) {
+  function stringifyTOC(obj, level) {
     ++level;
     var buf = '';
     var link;
@@ -71,25 +75,25 @@ function Markdown (runner) {
     return buf;
   }
 
-  function generateTOC (suite) {
+  function generateTOC(suite) {
     var obj = mapTOC(suite, {});
     return stringifyTOC(obj, 0);
   }
 
   generateTOC(runner.suite);
 
-  runner.on('suite', function (suite) {
+  runner.on(EVENT_SUITE_BEGIN, function(suite) {
     ++level;
     var slug = utils.slug(suite.fullTitle());
     buf += '<a name="' + slug + '"></a>' + '\n';
     buf += title(suite.title) + '\n';
   });
 
-  runner.on('suite end', function () {
+  runner.on(EVENT_SUITE_END, function() {
     --level;
   });
 
-  runner.on('pass', function (test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     var code = utils.clean(test.body);
     buf += test.title + '.\n';
     buf += '\n```js\n';
@@ -97,9 +101,11 @@ function Markdown (runner) {
     buf += '```\n\n';
   });
 
-  runner.once('end', function () {
+  runner.once(EVENT_RUN_END, function() {
     process.stdout.write('# TOC\n');
     process.stdout.write(generateTOC(runner.suite));
     process.stdout.write(buf);
   });
 }
+
+Markdown.description = 'GitHub Flavored Markdown';

package/lib/reporters/min.js

@@ -8,6 +8,9 @@
 
 var Base = require('./base');
 var inherits = require('../utils').inherits;
+var constants = require('../runner').constants;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
 
 /**
  * Expose `Min`.
@@ -22,23 +25,24 @@ exports = module.exports = Min;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
-function Min (runner) {
+function Min(runner) {
   Base.call(this, runner);
 
-  runner.on('start', function () {
+  runner.on(EVENT_RUN_BEGIN, function() {
     // clear screen
     process.stdout.write('\u001b[2J');
     // set cursor position
     process.stdout.write('\u001b[1;3H');
   });
 
-  runner.once('end', this.epilogue.bind(this));
+  runner.once(EVENT_RUN_END, this.epilogue.bind(this));
 }
 
 /**
  * Inherit from `Base.prototype`.
  */
 inherits(Min, Base);
+
+Min.description = 'essentially just a summary';

package/lib/reporters/nyan.js

@@ -7,7 +7,13 @@
  */
 
 var Base = require('./base');
+var constants = require('../runner').constants;
 var inherits = require('../utils').inherits;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
 
 /**
  * Expose `Dot`.
@@ -19,19 +25,18 @@ exports = module.exports = NyanCat;
  * Initialize a new `Dot` matrix test reporter.
  *
  * @param {Runner} runner
- * @api public
  * @public
  * @class Nyan
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
  */
 
-function NyanCat (runner) {
+function NyanCat(runner) {
   Base.call(this, runner);
 
   var self = this;
-  var width = Base.window.width * 0.75 | 0;
-  var nyanCatWidth = this.nyanCatWidth = 11;
+  var width = (Base.window.width * 0.75) | 0;
+  var nyanCatWidth = (this.nyanCatWidth = 11);
 
   this.colorIndex = 0;
   this.numberOfLines = 4;
@@ -39,26 +44,26 @@ function NyanCat (runner) {
   this.scoreboardWidth = 5;
   this.tick = 0;
   this.trajectories = [[], [], [], []];
-  this.trajectoryWidthMax = (width - nyanCatWidth);
+  this.trajectoryWidthMax = width - nyanCatWidth;
 
-  runner.on('start', function () {
+  runner.on(EVENT_RUN_BEGIN, function() {
     Base.cursor.hide();
     self.draw();
   });
 
-  runner.on('pending', function () {
+  runner.on(EVENT_TEST_PENDING, function() {
     self.draw();
   });
 
-  runner.on('pass', function () {
+  runner.on(EVENT_TEST_PASS, function() {
     self.draw();
   });
 
-  runner.on('fail', function () {
+  runner.on(EVENT_TEST_FAIL, function() {
     self.draw();
   });
 
-  runner.once('end', function () {
+  runner.once(EVENT_RUN_END, function() {
     Base.cursor.show();
     for (var i = 0; i < self.numberOfLines; i++) {
       write('\n');
@@ -75,10 +80,10 @@ inherits(NyanCat, Base);
 /**
  * Draw the nyan cat
  *
- * @api private
+ * @private
  */
 
-NyanCat.prototype.draw = function () {
+NyanCat.prototype.draw = function() {
   this.appendRainbow();
   this.drawScoreboard();
   this.drawRainbow();
@@ -90,13 +95,13 @@ NyanCat.prototype.draw = function () {
  * Draw the "scoreboard" showing the number
  * of passes, failures and pending tests.
  *
- * @api private
+ * @private
  */
 
-NyanCat.prototype.drawScoreboard = function () {
+NyanCat.prototype.drawScoreboard = function() {
   var stats = this.stats;
 
-  function draw (type, n) {
+  function draw(type, n) {
     write(' ');
     write(Base.color(type, n));
     write('\n');
@@ -113,10 +118,10 @@ NyanCat.prototype.drawScoreboard = function () {
 /**
  * Append the rainbow.
  *
- * @api private
+ * @private
  */
 
-NyanCat.prototype.appendRainbow = function () {
+NyanCat.prototype.appendRainbow = function() {
   var segment = this.tick ? '_' : '-';
   var rainbowified = this.rainbowify(segment);
 
@@ -132,13 +137,13 @@ NyanCat.prototype.appendRainbow = function () {
 /**
  * Draw the rainbow.
  *
- * @api private
+ * @private
  */
 
-NyanCat.prototype.drawRainbow = function () {
+NyanCat.prototype.drawRainbow = function() {
   var self = this;
 
-  this.trajectories.forEach(function (line) {
+  this.trajectories.forEach(function(line) {
     write('\u001b[' + self.scoreboardWidth + 'C');
     write(line.join(''));
     write('\n');
@@ -150,9 +155,9 @@ NyanCat.prototype.drawRainbow = function () {
 /**
  * Draw the nyan cat
  *
- * @api private
+ * @private
  */
-NyanCat.prototype.drawNyanCat = function () {
+NyanCat.prototype.drawNyanCat = function() {
   var self = this;
   var startWidth = this.scoreboardWidth + this.trajectories[0].length;
   var dist = '\u001b[' + startWidth + 'C';
@@ -184,11 +189,11 @@ NyanCat.prototype.drawNyanCat = function () {
 /**
  * Draw nyan cat face.
  *
- * @api private
+ * @private
  * @return {string}
  */
 
-NyanCat.prototype.face = function () {
+NyanCat.prototype.face = function() {
   var stats = this.stats;
   if (stats.failures) {
     return '( x .x)';
@@ -203,37 +208,37 @@ NyanCat.prototype.face = function () {
 /**
  * Move cursor up `n`.
  *
- * @api private
+ * @private
  * @param {number} n
  */
 
-NyanCat.prototype.cursorUp = function (n) {
+NyanCat.prototype.cursorUp = function(n) {
   write('\u001b[' + n + 'A');
 };
 
 /**
  * Move cursor down `n`.
  *
- * @api private
+ * @private
  * @param {number} n
  */
 
-NyanCat.prototype.cursorDown = function (n) {
+NyanCat.prototype.cursorDown = function(n) {
   write('\u001b[' + n + 'B');
 };
 
 /**
  * Generate rainbow colors.
  *
- * @api private
+ * @private
  * @return {Array}
  */
-NyanCat.prototype.generateColors = function () {
+NyanCat.prototype.generateColors = function() {
   var colors = [];
 
-  for (var i = 0; i < (6 * 7); i++) {
+  for (var i = 0; i < 6 * 7; i++) {
     var pi3 = Math.floor(Math.PI / 3);
-    var n = (i * (1.0 / 6));
+    var n = i * (1.0 / 6);
     var r = Math.floor(3 * Math.sin(n) + 3);
     var g = Math.floor(3 * Math.sin(n + 2 * pi3) + 3);
     var b = Math.floor(3 * Math.sin(n + 4 * pi3) + 3);
@@ -246,11 +251,11 @@ NyanCat.prototype.generateColors = function () {
 /**
  * Apply rainbow to the given `str`.
  *
- * @api private
+ * @private
  * @param {string} str
  * @return {string}
  */
-NyanCat.prototype.rainbowify = function (str) {
+NyanCat.prototype.rainbowify = function(str) {
   if (!Base.useColors) {
     return str;
   }
@@ -264,6 +269,8 @@ NyanCat.prototype.rainbowify = function (str) {
  *
  * @param {string} string A message to write to stdout.
  */
-function write (string) {
+function write(string) {
   process.stdout.write(string);
 }
+
+NyanCat.description = '"nyan cat"';

package/lib/reporters/progress.js

@@ -7,6 +7,10 @@
  */
 
 var Base = require('./base');
+var constants = require('../runner').constants;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_TEST_END = constants.EVENT_TEST_END;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
 var inherits = require('../utils').inherits;
 var color = Base.color;
 var cursor = Base.cursor;
@@ -30,15 +34,14 @@ Base.colors.progress = 90;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  * @param {Object} options
  */
-function Progress (runner, options) {
+function Progress(runner, options) {
   Base.call(this, runner);
 
   var self = this;
-  var width = Base.window.width * 0.50 | 0;
+  var width = (Base.window.width * 0.5) | 0;
   var total = runner.total;
   var complete = 0;
   var lastN = -1;
@@ -54,17 +57,17 @@ function Progress (runner, options) {
   options.verbose = reporterOptions.verbose || false;
 
   // tests started
-  runner.on('start', function () {
+  runner.on(EVENT_RUN_BEGIN, function() {
     console.log();
     cursor.hide();
   });
 
   // tests complete
-  runner.on('test end', function () {
+  runner.on(EVENT_TEST_END, function() {
     complete++;
 
     var percent = complete / total;
-    var n = width * percent | 0;
+    var n = (width * percent) | 0;
     var i = width - n;
 
     if (n === lastN && !options.verbose) {
@@ -86,7 +89,7 @@ function Progress (runner, options) {
 
   // tests are complete, output some stats
   // and the failures if any
-  runner.once('end', function () {
+  runner.once(EVENT_RUN_END, function() {
     cursor.show();
     console.log();
     self.epilogue();
@@ -97,3 +100,5 @@ function Progress (runner, options) {
  * Inherit from `Base.prototype`.
  */
 inherits(Progress, Base);
+
+Progress.description = 'a progress bar';

package/lib/reporters/spec.js

@@ -7,6 +7,14 @@
  */
 
 var Base = require('./base');
+var constants = require('../runner').constants;
+var EVENT_RUN_BEGIN = constants.EVENT_RUN_BEGIN;
+var EVENT_RUN_END = constants.EVENT_RUN_END;
+var EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
+var EVENT_SUITE_END = constants.EVENT_SUITE_END;
+var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
+var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
+var EVENT_TEST_PENDING = constants.EVENT_TEST_PENDING;
 var inherits = require('../utils').inherits;
 var color = Base.color;
 
@@ -23,50 +31,51 @@ exports = module.exports = Spec;
  * @class
  * @memberof Mocha.reporters
  * @extends Mocha.reporters.Base
- * @api public
  * @param {Runner} runner
  */
-function Spec (runner) {
+function Spec(runner) {
   Base.call(this, runner);
 
   var self = this;
   var indents = 0;
   var n = 0;
 
-  function indent () {
+  function indent() {
     return Array(indents).join('  ');
   }
 
-  runner.on('start', function () {
+  runner.on(EVENT_RUN_BEGIN, function() {
     console.log();
   });
 
-  runner.on('suite', function (suite) {
+  runner.on(EVENT_SUITE_BEGIN, function(suite) {
     ++indents;
     console.log(color('suite', '%s%s'), indent(), suite.title);
   });
 
-  runner.on('suite end', function () {
+  runner.on(EVENT_SUITE_END, function() {
     --indents;
     if (indents === 1) {
       console.log();
     }
   });
 
-  runner.on('pending', function (test) {
+  runner.on(EVENT_TEST_PENDING, function(test) {
     var fmt = indent() + color('pending', '  - %s');
     console.log(fmt, test.title);
   });
 
-  runner.on('pass', function (test) {
+  runner.on(EVENT_TEST_PASS, function(test) {
     var fmt;
     if (test.speed === 'fast') {
-      fmt = indent() +
+      fmt =
+        indent() +
         color('checkmark', '  ' + Base.symbols.ok) +
         color('pass', ' %s');
       console.log(fmt, test.title);
     } else {
-      fmt = indent() +
+      fmt =
+        indent() +
         color('checkmark', '  ' + Base.symbols.ok) +
         color('pass', ' %s') +
         color(test.speed, ' (%dms)');
@@ -74,14 +83,16 @@ function Spec (runner) {
     }
   });
 
-  runner.on('fail', function (test) {
+  runner.on(EVENT_TEST_FAIL, function(test) {
     console.log(indent() + color('fail', '  %d) %s'), ++n, test.title);
   });
 
-  runner.once('end', self.epilogue.bind(self));
+  runner.once(EVENT_RUN_END, self.epilogue.bind(self));
 }
 
 /**
  * Inherit from `Base.prototype`.
  */
 inherits(Spec, Base);
+
+Spec.description = 'hierarchical & verbose [default]';