lib/cli

包含 CLI 入口点和用于 Node.js 中编程使用的公共 API。

  • 选项解析由 yargs 处理。
  • 如果通过 node 执行,此模块将运行 main()
源代码

方法

(静态) loadOptions(argv可选) → {external:yargsParser.Arguments}

解析从 .mocharc.*package.json 读取的选项。

源代码

优先级列表

  1. 命令行参数
  2. RC 文件 (.mocharc.c?js, .mocharc.ya?ml, mocharc.json)
  3. package.jsonmocha 属性
  4. 默认配置 (lib/mocharc.json)

如果 argv 数组中存在“一次性”选项,则不会读取任何外部配置文件。

Parameters
名称类型属性描述
argvstring | Array:.<string:><可选>

要解析的参数

返回值

从所有内容解析的参数

类型
external:yargsParser.Arguments

(静态) loadPkgRc(args可选) → {external:yargsParser.Arguments|void}

源代码

args.package 中给定 package.json 的路径,尝试从 mocha 属性加载配置。

Parameters
名称类型属性描述
argsObject<可选>

参数对象

属性
名称类型属性描述
configstring | boolean<可选>

package.json 的路径或 false 以跳过

返回值

解析的配置,如果 args.packagefalse 则为空

类型
external:yargsParser.Arguments | void

(静态) loadRc(args可选) → {external:yargsParser.Arguments|void}

源代码

args.config 中给定配置文件的路径,尝试加载和解析配置文件。

Parameters
名称类型属性描述
argsObject<可选>

参数对象

属性
名称类型属性描述
configstring | boolean<可选>

配置文件的路径或 false 以跳过

返回值

解析的配置,如果 args.configfalse 则为空

类型
external:yargsParser.Arguments | void

(静态) lookupFiles(filepath, extensions可选, recursive可选) → {Array:.<string:>}

源代码

文件名按操作系统/文件系统的遍历顺序返回。
不要假设名称将以任何方式排序。

Parameters
名称类型属性默认值描述
filepathstring

要开始搜索的基路径。

extensionsArray:.<string:><可选>
[]

要查找的文件扩展名。

recursiveboolean<可选>
false

是否递归进入子目录。

抛出
  • 如果没有任何文件匹配模式。

    类型
    Error
  • 如果 filepath 是目录并且未提供 extensions

    类型
    TypeError
返回值

路径数组。

类型
Array:.<string:>

(静态) main(argv, mochaArgs可选)

Mocha 的主要命令行入口点。

源代码
Parameters
名称类型属性描述
argvArray:.<string:>

要解析的参数数组,或者默认情况下是可爱的 process.argv.slice(2)

mochaArgsobject<可选>

已解析的 Mocha 参数对象 (由 bin/mocha 解析)