Main entry point for handling filesystem-based configuration,
whether that's mocha.opts or a config file or package.json or whatever.
- Source:
Methods
(static) loadMochaOpts(argsopt) → {external:yargsParser.Arguments|void}
- Source:
- See:
- mocha.opts
Given filepath in args.opts, attempt to load and parse a mocha.opts file.
Parameters:
| Name | Type | Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
args | Object | <optional> | Arguments object Properties
|
Returns:
If read, object containing parsed arguments
- Type
- external:yargsParser.Arguments | void
(static) loadOptions(argvopt) → {external:yargsParser.Arguments}
Parses options read from mocha.opts, .mocharc.* and package.json.
- Source:
Priority list:
- Command-line args
- RC file (
.mocharc.js,.mocharc.ya?ml,mocharc.json) mochaprop ofpackage.jsonmocha.opts- default configuration (
lib/mocharc.json)
If a "one-and-done" option is present in the argv array, no external config files will be read.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
argv | string | Array:.<string:> | <optional> | Arguments to parse |
Returns:
Parsed args from everything
(static) loadPkgRc(argsopt) → {external:yargsParser.Arguments|void}
- Source:
Given path to package.json in args.package, attempt to load config from mocha prop.
Parameters:
| Name | Type | Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
args | Object | <optional> | Arguments object Properties
|
Returns:
Parsed config, or nothing if args.package is false
- Type
- external:yargsParser.Arguments | void
(static) loadRc(argsopt) → {external:yargsParser.Arguments|void}
- Source:
Given path to config file in args.config, attempt to load & parse config file.
Parameters:
| Name | Type | Attributes | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
args | Object | <optional> | Arguments object Properties
|
Returns:
Parsed config, or nothing if args.config is false
- Type
- external:yargsParser.Arguments | void