Skip to content

armgit / mocha

Public Imported from GitHub
0

☕️ Classic, reliable, trusted test framework for Node.js and the browser

Improve reporter documentation for mocha in browser. (#4026)

Lindsay-Needs-Sleep3a0ef50d61fb
diff --git a/docs/index.md b/docs/index.md
index 5dac9ff1..40d38aae 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -869,17 +869,19 @@ Configuration
--package Path to package.json for config [string]
File Handling
- --extension, --watch-extensions File extension(s) to load and/or watch
- [array] [default: js]
- --file Specify file(s) to be loaded prior to root
- suite execution [array] [default: (none)]
- --ignore, --exclude Ignore file(s) or glob pattern(s)
+ --extension File extension(s) to load [array] [default: js]
+ --file Specify file(s) to be loaded prior to root suite
+ execution [array] [default: (none)]
+ --ignore, --exclude Ignore file(s) or glob pattern(s)
[array] [default: (none)]
- --recursive Look for tests in subdirectories [boolean]
- --require, -r Require module [array] [default: (none)]
- --sort, -S Sort test files [boolean]
- --watch, -w Watch files in the current working directory
- for changes [boolean]
+ --recursive Look for tests in subdirectories [boolean]
+ --require, -r Require module [array] [default: (none)]
+ --sort, -S Sort test files [boolean]
+ --watch, -w Watch files in the current working directory for changes
+ [boolean]
+ --watch-files List of paths or globs to watch [array]
+ --watch-ignore List of paths or globs to exclude from watching
+ [array] [default: ["node_modules",".git"]]
Test Filters
--fgrep, -f Only run tests containing this string [string]
@@ -1566,23 +1568,32 @@ mocha.setup({
ui: 'tdd'
});
-// Use "tdd" interface, ignore leaks, and force all tests to be asynchronous
+// Use "tdd" interface, check global leaks, and force all tests to be asynchronous
mocha.setup({
ui: 'tdd',
- checkLeaks: false, // default
+ checkLeaks: true,
asyncOnly: true
});
```
### Browser-specific Option(s)
-The following option(s) _only_ function in a browser context:
+Browser Mocha supports many, but not all [cli options](#command-line-usage).
+To use a [cli option](#command-line-usage) that contains a "-", please convert the option to camel-case, (eg. `check-leaks` to `checkLeaks`).
-`noHighlighting`: If set to `true`, do not attempt to use syntax highlighting on output test code.
+#### Options that differ slightly from [cli options](#command-line-usage):
+
+`reporter` _{string|constructor}_
+You can pass a reporter's name or a custom reporter's constructor. You can find **recommended** reporters for the browser [here](#reporting). It is possible to use [built-in reporters](#reporters) as well. Their employment in browsers is neither recommended nor supported, open the console to see the test results.
+
+#### Options that _only_ function in browser context:
+
+`noHighlighting` _{boolean}_
+If set to `true`, do not attempt to use syntax highlighting on output test code.
### 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"}
diff --git a/lib/mocha.js b/lib/mocha.js
index 6c8bf256..839a5231 100644
--- a/lib/mocha.js
+++ b/lib/mocha.js
@@ -83,7 +83,7 @@ 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.