lib/cli - Documentation

Contains CLI entry point and public API for programmatic usage in Node.js.

Option parsing is handled by yargs.
If executed via node, this module will run main().

Source:

cli/cli.js, line 5

Methods

(static) loadOptions(argvopt) → {external:yargsParser.Arguments}

Parses options read from .mocharc.* and package.json.

Source:

cli/options.js, line 217

Priority list:

Command-line args
RC file (.mocharc.c?js, .mocharc.ya?ml, mocharc.json)
mocha prop of package.json
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

Type: external:yargsParser.Arguments

(static) loadPkgRc(argsopt) → {external:yargsParser.Arguments|void}

Source:

cli/options.js, line 174

Given path to package.json in args.package, attempt to load config from mocha prop.

Parameters:

Name Type Attributes Description

args

Object

Arguments object

Properties

Name	Type	Attributes	Description
`config`	string \| boolean	<optional>	Path to `package.json` or `false` to skip

Returns:

Parsed config, or nothing if args.package is false

Type: external:yargsParser.Arguments | void

(static) loadRc(argsopt) → {external:yargsParser.Arguments|void}

Source:

cli/options.js, line 157

Given path to config file in args.config, attempt to load & parse config file.

Parameters:

Name Type Attributes Description

args

Object

Arguments object

Properties

Name	Type	Attributes	Description
`config`	string \| boolean	<optional>	Path to config file or `false` to skip

Returns:

Parsed config, or nothing if args.config is false

Type: external:yargsParser.Arguments | void

(static) lookupFiles(filepath, extensionsopt, recursiveopt) → {Array:.<string:>}

Source:

cli/lookup-files.js, line 70

Filenames are returned in traversal order by the OS/filesystem.
Make no assumption that the names will be sorted in any fashion.

Parameters:

Name	Type	Attributes	Default	Description
`filepath`	string			Base path to start searching from.
`extensions`	Array:.<string:>	<optional>	`[]`	File extensions to look for.
`recursive`	boolean	<optional>	`false`	Whether to recurse into subdirectories.

Throws:

if no files match pattern.

Type

Error
if filepath is directory and extensions not provided.

Type

TypeError

Returns:

An array of paths.

Type: Array:.<string:>

(static) lookupFiles(filepath, extensionsopt, recursiveopt) → {Array:.<string:>}

Source:

utils.js, line 666

Deprecated:

Moved to module:lib/cli.lookupFiles

Filenames are returned in traversal order by the OS/filesystem.
Make no assumption that the names will be sorted in any fashion.

Parameters:

Name	Type	Attributes	Default	Description
`filepath`	string			Base path to start searching from.
`extensions`	Array:.<string:>	<optional>	`[]`	File extensions to look for.
`recursive`	boolean	<optional>	`false`	Whether to recurse into subdirectories.

Throws:

if no files match pattern.

Type

Error
if filepath is directory and extensions not provided.

Type

TypeError

Returns:

An array of paths.

Type: Array:.<string:>

(static) main(argv)

Mocha's main command-line entry-point.

Source:

cli/cli.js, line 37

Accepts an Array of arguments
Modifies Node.js' search path for easy loading of consumer modules
Sets Error.stackTraceLimit to Infinity

Parameters:

Name	Type	Description
`argv`	Array:.<string:>	Array of arguments to parse, or by default the lovely `process.argv.slice(2)`