mocha-compat 3.6.4 → 10.8.2

package/lib/reporters/nyan.js

@@ -1,11 +1,19 @@
 'use strict';
-
+/**
+ * @module Nyan
+ */
 /**
  * Module dependencies.
  */
 
 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`.
@@ -14,18 +22,21 @@ var inherits = require('../utils').inherits;
 exports = module.exports = NyanCat;
 
 /**
- * Initialize a new `Dot` matrix test reporter.
+ * Constructs a new `Nyan` reporter instance.
  *
- * @param {Runner} runner
- * @api public
+ * @public
+ * @class Nyan
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
+ * @param {Runner} runner - Instance triggers reporter actions.
+ * @param {Object} [options] - runner options
  */
-
-function NyanCat (runner) {
-  Base.call(this, runner);
+function NyanCat(runner, options) {
+  Base.call(this, runner, options);
 
   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;
@@ -33,29 +44,29 @@ 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.on('end', function () {
+  runner.once(EVENT_RUN_END, function () {
     Base.cursor.show();
     for (var i = 0; i < self.numberOfLines; i++) {
-      write('\n');
+      process.stdout.write('\n');
     }
     self.epilogue();
   });
@@ -69,7 +80,7 @@ inherits(NyanCat, Base);
 /**
  * Draw the nyan cat
  *
- * @api private
+ * @private
  */
 
 NyanCat.prototype.draw = function () {
@@ -84,22 +95,22 @@ NyanCat.prototype.draw = function () {
  * Draw the "scoreboard" showing the number
  * of passes, failures and pending tests.
  *
- * @api private
+ * @private
  */
 
 NyanCat.prototype.drawScoreboard = function () {
   var stats = this.stats;
 
-  function draw (type, n) {
-    write(' ');
-    write(Base.color(type, n));
-    write('\n');
+  function draw(type, n) {
+    process.stdout.write(' ');
+    process.stdout.write(Base.color(type, n));
+    process.stdout.write('\n');
   }
 
   draw('green', stats.passes);
   draw('fail', stats.failures);
   draw('pending', stats.pending);
-  write('\n');
+  process.stdout.write('\n');
 
   this.cursorUp(this.numberOfLines);
 };
@@ -107,7 +118,7 @@ NyanCat.prototype.drawScoreboard = function () {
 /**
  * Append the rainbow.
  *
- * @api private
+ * @private
  */
 
 NyanCat.prototype.appendRainbow = function () {
@@ -126,16 +137,16 @@ NyanCat.prototype.appendRainbow = function () {
 /**
  * Draw the rainbow.
  *
- * @api private
+ * @private
  */
 
 NyanCat.prototype.drawRainbow = function () {
   var self = this;
 
   this.trajectories.forEach(function (line) {
-    write('\u001b[' + self.scoreboardWidth + 'C');
-    write(line.join(''));
-    write('\n');
+    process.stdout.write('\u001b[' + self.scoreboardWidth + 'C');
+    process.stdout.write(line.join(''));
+    process.stdout.write('\n');
   });
 
   this.cursorUp(this.numberOfLines);
@@ -144,7 +155,7 @@ NyanCat.prototype.drawRainbow = function () {
 /**
  * Draw the nyan cat
  *
- * @api private
+ * @private
  */
 NyanCat.prototype.drawNyanCat = function () {
   var self = this;
@@ -152,25 +163,25 @@ NyanCat.prototype.drawNyanCat = function () {
   var dist = '\u001b[' + startWidth + 'C';
   var padding = '';
 
-  write(dist);
-  write('_,------,');
-  write('\n');
+  process.stdout.write(dist);
+  process.stdout.write('_,------,');
+  process.stdout.write('\n');
 
-  write(dist);
+  process.stdout.write(dist);
   padding = self.tick ? '  ' : '   ';
-  write('_|' + padding + '/\\_/\\ ');
-  write('\n');
+  process.stdout.write('_|' + padding + '/\\_/\\ ');
+  process.stdout.write('\n');
 
-  write(dist);
+  process.stdout.write(dist);
   padding = self.tick ? '_' : '__';
   var tail = self.tick ? '~' : '^';
-  write(tail + '|' + padding + this.face() + ' ');
-  write('\n');
+  process.stdout.write(tail + '|' + padding + this.face() + ' ');
+  process.stdout.write('\n');
 
-  write(dist);
+  process.stdout.write(dist);
   padding = self.tick ? ' ' : '  ';
-  write(padding + '""  "" ');
-  write('\n');
+  process.stdout.write(padding + '""  "" ');
+  process.stdout.write('\n');
 
   this.cursorUp(this.numberOfLines);
 };
@@ -178,7 +189,7 @@ NyanCat.prototype.drawNyanCat = function () {
 /**
  * Draw nyan cat face.
  *
- * @api private
+ * @private
  * @return {string}
  */
 
@@ -197,37 +208,37 @@ NyanCat.prototype.face = function () {
 /**
  * Move cursor up `n`.
  *
- * @api private
+ * @private
  * @param {number} n
  */
 
 NyanCat.prototype.cursorUp = function (n) {
-  write('\u001b[' + n + 'A');
+  process.stdout.write('\u001b[' + n + 'A');
 };
 
 /**
  * Move cursor down `n`.
  *
- * @api private
+ * @private
  * @param {number} n
  */
 
 NyanCat.prototype.cursorDown = function (n) {
-  write('\u001b[' + n + 'B');
+  process.stdout.write('\u001b[' + n + 'B');
 };
 
 /**
  * Generate rainbow colors.
  *
- * @api private
+ * @private
  * @return {Array}
  */
 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);
@@ -240,7 +251,7 @@ NyanCat.prototype.generateColors = function () {
 /**
  * Apply rainbow to the given `str`.
  *
- * @api private
+ * @private
  * @param {string} str
  * @return {string}
  */
@@ -253,11 +264,4 @@ NyanCat.prototype.rainbowify = function (str) {
   return '\u001b[38;5;' + color + 'm' + str + '\u001b[0m';
 };
 
-/**
- * Stdout helper.
- *
- * @param {string} string A message to write to stdout.
- */
-function write (string) {
-  process.stdout.write(string);
-}
+NyanCat.description = '"nyan cat"';

package/lib/reporters/progress.js

@@ -1,10 +1,16 @@
 'use strict';
-
+/**
+ * @module Progress
+ */
 /**
  * Module dependencies.
  */
 
 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;
@@ -22,41 +28,46 @@ exports = module.exports = Progress;
 Base.colors.progress = 90;
 
 /**
- * Initialize a new `Progress` bar test reporter.
+ * Constructs a new `Progress` reporter instance.
  *
- * @api public
- * @param {Runner} runner
- * @param {Object} options
+ * @public
+ * @class
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
+ * @param {Runner} runner - Instance triggers reporter actions.
+ * @param {Object} [options] - runner options
  */
-function Progress (runner, options) {
-  Base.call(this, runner);
+function Progress(runner, options) {
+  Base.call(this, runner, options);
 
   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;
 
   // default chars
   options = options || {};
-  options.open = options.open || '[';
-  options.complete = options.complete || '▬';
-  options.incomplete = options.incomplete || Base.symbols.dot;
-  options.close = options.close || ']';
-  options.verbose = false;
+  var reporterOptions = options.reporterOptions || {};
+
+  options.open = reporterOptions.open || '[';
+  options.complete = reporterOptions.complete || '▬';
+  options.incomplete = reporterOptions.incomplete || Base.symbols.dot;
+  options.close = reporterOptions.close || ']';
+  options.verbose = reporterOptions.verbose || false;
 
   // tests started
-  runner.on('start', function () {
-    console.log();
+  runner.on(EVENT_RUN_BEGIN, function () {
+    process.stdout.write('\n');
     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) {
@@ -78,9 +89,9 @@ function Progress (runner, options) {
 
   // tests are complete, output some stats
   // and the failures if any
-  runner.on('end', function () {
+  runner.once(EVENT_RUN_END, function () {
     cursor.show();
-    console.log();
+    process.stdout.write('\n');
     self.epilogue();
   });
 }
@@ -89,3 +100,5 @@ function Progress (runner, options) {
  * Inherit from `Base.prototype`.
  */
 inherits(Progress, Base);
+
+Progress.description = 'a progress bar';

package/lib/reporters/spec.js

@@ -1,10 +1,20 @@
 'use strict';
-
+/**
+ * @module Spec
+ */
 /**
  * Module dependencies.
  */
 
 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;
 
@@ -15,67 +25,75 @@ var color = Base.color;
 exports = module.exports = Spec;
 
 /**
- * Initialize a new `Spec` test reporter.
+ * Constructs a new `Spec` reporter instance.
  *
- * @api public
- * @param {Runner} runner
+ * @public
+ * @class
+ * @memberof Mocha.reporters
+ * @extends Mocha.reporters.Base
+ * @param {Runner} runner - Instance triggers reporter actions.
+ * @param {Object} [options] - runner options
  */
-function Spec (runner) {
-  Base.call(this, runner);
+function Spec(runner, options) {
+  Base.call(this, runner, options);
 
   var self = this;
   var indents = 0;
   var n = 0;
 
-  function indent () {
+  function indent() {
     return Array(indents).join('  ');
   }
 
-  runner.on('start', function () {
-    console.log();
+  runner.on(EVENT_RUN_BEGIN, function () {
+    Base.consoleLog();
   });
 
-  runner.on('suite', function (suite) {
+  runner.on(EVENT_SUITE_BEGIN, function (suite) {
     ++indents;
-    console.log(color('suite', '%s%s'), indent(), suite.title);
+    Base.consoleLog(color('suite', '%s%s'), indent(), suite.title);
   });
 
-  runner.on('suite end', function () {
+  runner.on(EVENT_SUITE_END, function () {
     --indents;
     if (indents === 1) {
-      console.log();
+      Base.consoleLog();
     }
   });
 
-  runner.on('pending', function (test) {
+  runner.on(EVENT_TEST_PENDING, function (test) {
     var fmt = indent() + color('pending', '  - %s');
-    console.log(fmt, test.title);
+    Base.consoleLog(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);
+      Base.consoleLog(fmt, test.title);
     } else {
-      fmt = indent() +
+      fmt =
+        indent() +
         color('checkmark', '  ' + Base.symbols.ok) +
         color('pass', ' %s') +
         color(test.speed, ' (%dms)');
-      console.log(fmt, test.title, test.duration);
+      Base.consoleLog(fmt, test.title, test.duration);
     }
   });
 
-  runner.on('fail', function (test) {
-    console.log(indent() + color('fail', '  %d) %s'), ++n, test.title);
+  runner.on(EVENT_TEST_FAIL, function (test) {
+    Base.consoleLog(indent() + color('fail', '  %d) %s'), ++n, test.title);
   });
 
-  runner.on('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]';