doc.js 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. 'use strict';
  2. /**
  3. * @typedef {import('../runner.js')} Runner
  4. */
  5. /**
  6. * @module Doc
  7. */
  8. /**
  9. * Module dependencies.
  10. */
  11. var Base = require('./base');
  12. var utils = require('../utils');
  13. var constants = require('../runner').constants;
  14. var EVENT_TEST_PASS = constants.EVENT_TEST_PASS;
  15. var EVENT_TEST_FAIL = constants.EVENT_TEST_FAIL;
  16. var EVENT_SUITE_BEGIN = constants.EVENT_SUITE_BEGIN;
  17. var EVENT_SUITE_END = constants.EVENT_SUITE_END;
  18. /**
  19. * Expose `Doc`.
  20. */
  21. exports = module.exports = Doc;
  22. /**
  23. * Constructs a new `Doc` reporter instance.
  24. *
  25. * @public
  26. * @class
  27. * @memberof Mocha.reporters
  28. * @extends Mocha.reporters.Base
  29. * @param {Runner} runner - Instance triggers reporter actions.
  30. * @param {Object} [options] - runner options
  31. */
  32. function Doc(runner, options) {
  33. Base.call(this, runner, options);
  34. var indents = 2;
  35. function indent() {
  36. return Array(indents).join(' ');
  37. }
  38. runner.on(EVENT_SUITE_BEGIN, function (suite) {
  39. if (suite.root) {
  40. return;
  41. }
  42. ++indents;
  43. Base.consoleLog('%s<section class="suite">', indent());
  44. ++indents;
  45. Base.consoleLog('%s<h1>%s</h1>', indent(), utils.escape(suite.title));
  46. Base.consoleLog('%s<dl>', indent());
  47. });
  48. runner.on(EVENT_SUITE_END, function (suite) {
  49. if (suite.root) {
  50. return;
  51. }
  52. Base.consoleLog('%s</dl>', indent());
  53. --indents;
  54. Base.consoleLog('%s</section>', indent());
  55. --indents;
  56. });
  57. runner.on(EVENT_TEST_PASS, function (test) {
  58. Base.consoleLog('%s <dt>%s</dt>', indent(), utils.escape(test.title));
  59. Base.consoleLog('%s <dt>%s</dt>', indent(), utils.escape(test.file));
  60. var code = utils.escape(utils.clean(test.body));
  61. Base.consoleLog('%s <dd><pre><code>%s</code></pre></dd>', indent(), code);
  62. });
  63. runner.on(EVENT_TEST_FAIL, function (test, err) {
  64. Base.consoleLog(
  65. '%s <dt class="error">%s</dt>',
  66. indent(),
  67. utils.escape(test.title)
  68. );
  69. Base.consoleLog(
  70. '%s <dt class="error">%s</dt>',
  71. indent(),
  72. utils.escape(test.file)
  73. );
  74. var code = utils.escape(utils.clean(test.body));
  75. Base.consoleLog(
  76. '%s <dd class="error"><pre><code>%s</code></pre></dd>',
  77. indent(),
  78. code
  79. );
  80. Base.consoleLog(
  81. '%s <dd class="error">%s</dd>',
  82. indent(),
  83. utils.escape(err)
  84. );
  85. });
  86. }
  87. Doc.description = 'HTML documentation';