From 38af3049f021262393f438718e48ee7a7c8c674d Mon Sep 17 00:00:00 2001 From: juergba Date: Mon, 26 Aug 2019 14:42:43 +0200 Subject: [PATCH] docu: various --- docs/index.md | 43 ++++++++++++++++++++++--------------------- 1 file changed, 22 insertions(+), 21 deletions(-) diff --git a/docs/index.md b/docs/index.md index ad4b995496..50b5536aeb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -828,8 +828,8 @@ mocha [spec..] Run tests with Mocha Commands - mocha debug [spec..] Run tests with Mocha [default] - mocha init create a client-side Mocha setup at + mocha inspect [spec..] Run tests with Mocha [default] + mocha init create a client-side Mocha setup at Rules & Behavior --allow-uncaught Allow uncaught errors to propagate [boolean] @@ -844,9 +844,9 @@ Rules & Behavior --global, --globals List of allowed global variables [array] --retries Retry failed tests this many times [number] --slow, -s Specify "slow" test threshold (in milliseconds) - [number] [default: 75] + [string] [default: 75] --timeout, -t, --timeouts Specify test timeout threshold (in milliseconds) - [number] [default: 2000] + [string] [default: 2000] --ui, -u Specify user interface [string] [default: "bdd"] Reporting & Output @@ -863,17 +863,18 @@ Reporting & Output -O () [array] Configuration - --config Path to config file [default: (nearest rc file)] - --opts Path to `mocha.opts` [string] [default: "./test/mocha.opts"] + --config Path to config file [string] [default: (nearest rc file)] + --opts Path to `mocha.opts` (DEPRECATED) + [string] [default: "./test/mocha.opts"] --package Path to package.json for config [string] File Handling - --ignore, --exclude Ignore file(s) or glob pattern(s) - [array] [default: (none)] --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) + [array] [default: (none)] --recursive Look for tests in subdirectories [boolean] --require, -r Require module [array] [default: (none)] --sort, -S Sort test files [boolean] @@ -890,10 +891,10 @@ Positional Arguments [array] [default: ["test"]] Other Options - --help, -h Show usage information & exit [boolean] - --version, -V Show version number & exit [boolean] - --list-interfaces List built-in user interfaces & exit [boolean] - --list-reporters List built-in reporters & exit [boolean] + --help, -h Show usage information & exit [boolean] + --version, -V Show version number & exit [boolean] + --list-interfaces List built-in user interfaces & exit [boolean] + --list-reporters List built-in reporters & exit [boolean] Mocha Resources Chat: https://gitter.im/mochajs/mocha @@ -1079,14 +1080,6 @@ Specify an explicit path to a [`package.json` file](#configuring-mocha-nodejs) ( By default, Mocha looks for a `package.json` in the current working directory or nearest ancestor, and will use the first file found (regardless of whether it contains a `mocha` property); to suppress `package.json` lookup, use `--no-package`. -### `--ignore ` - -Explicitly ignore (exclude) one or more test files, directories or globs (e.g., `some/**/files*`) that would otherwise be loaded. - -Files specified using `--file` _are not affected_ by this option. - -Can be specified multiple times. - ### `--extension , --watch-extensions ` > _Updated in v6.0.0. Previously `--watch-extensions`, but now expanded to affect general test file loading behavior. `--watch-extensions` is now an alias_ @@ -1099,7 +1092,7 @@ Specifying `--extension` will _remove_ `.js` as a test file extension; use `--ex ### `--file ` -Explicitly _include_ a test file to be loaded before other test files files. Multiple uses of `--file` are allowed, and will be loaded in order given. +Explicitly _include_ a test file to be loaded before other test files. Multiple uses of `--file` are allowed, and will be loaded in order given. Useful if you want to declare, for example, hooks to be run before every test across all other test files. @@ -1107,6 +1100,14 @@ Files specified this way are not affected by `--sort` or `--recursive`. Files specified in this way should contain one or more suites, tests or hooks. If this is not the case, consider `--require` instead. +### `--ignore , --exclude ,` + +Explicitly ignore (exclude) one or more test files, directories or globs (e.g., `some/**/files*`) that would otherwise be loaded. + +Files specified using `--file` _are not affected_ by this option. + +Can be specified multiple times. + ### `--recursive` When looking for test files, recurse into subdirectories.