Skip to content

Commit

Permalink
Issue #1592 Improve documentation for mocha in browser.
Browse files Browse the repository at this point in the history
You can pass the constructor function of your custom reporter in options and mocha will use it.
  • Loading branch information
Lindsay-Needs-Sleep committed Oct 8, 2019
1 parent ba96962 commit 455505e
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
12 changes: 11 additions & 1 deletion docs/index.md
Expand Up @@ -1574,6 +1574,16 @@ mocha.setup({
});
```

Some available options:

```text
reporter {string|constructor} - Reporter** name or constructor.
ui {string} - Interface name.
useColors {boolean} - Use color TTY output from reporter?
```

\*\* Available built in reporters that can be referenced by name [here](#reporters), and recommended reporters for the browser [here](#reporting).

### Browser-specific Option(s)

The following option(s) _only_ function in a browser context:
Expand All @@ -1582,7 +1592,7 @@ The following option(s) _only_ function in a browser context:

### Reporting

The "HTML" reporter is what you see when running Mocha in the browser. It looks like this:
The "HTML" reporter is the default reporter when running Mocha in the browser. It looks like this:

![HTML test reporter](images/reporter-html.png?withoutEnlargement&resize=920,9999){:class="screenshot" lazyload="on"}

Expand Down
4 changes: 2 additions & 2 deletions lib/mocha.js
Expand Up @@ -70,7 +70,6 @@ exports.Test = require('./test');
* @param {boolean} [options.asyncOnly] - Force `done` callback or promise?
* @param {boolean} [options.bail] - Bail after first test failure?
* @param {boolean} [options.checkLeaks] - Check for global variable leaks?
* @param {boolean} [options.color] - Color TTY output from reporter?
* @param {boolean} [options.delay] - Delay root suite execution?
* @param {boolean} [options.diff] - Show diff on failure?
* @param {string} [options.fgrep] - Test filter given string.
Expand All @@ -83,12 +82,13 @@ exports.Test = require('./test');
* @param {boolean} [options.inlineDiffs] - Display inline diffs?
* @param {boolean} [options.invert] - Invert test filter matches?
* @param {boolean} [options.noHighlighting] - Disable syntax highlighting?
* @param {string} [options.reporter] - Reporter name.
* @param {string|constructor} [options.reporter] - Reporter name or constructor.
* @param {Object} [options.reporterOption] - Reporter settings object.
* @param {number} [options.retries] - Number of times to retry failed tests.
* @param {number} [options.slow] - Slow threshold value.
* @param {number|string} [options.timeout] - Timeout threshold value.
* @param {string} [options.ui] - Interface name.
* @param {boolean} [options.useColors] - Use color TTY output from reporter?
*/
function Mocha(options) {
options = utils.assign({}, mocharc, options || {});
Expand Down

0 comments on commit 455505e

Please sign in to comment.