Node.jsでのプログラムによる使用のためのCLIエントリポイントと公開APIを含みます。
- ソース
メソッド
(static) loadOptions(argvopt) → {external:yargsParser.Arguments}
.mocharc.*
とpackage.json
から読み取ったオプションを解析します。
優先順位リスト
- コマンドライン引数
- RCファイル(
.mocharc.c?js
、.mocharc.ya?ml
、mocharc.json
) package.json
のmocha
プロパティ- デフォルト設定(
lib/mocharc.json
)
「ワンアンドオン」オプションがargv
配列に存在する場合、外部の設定ファイルは読み込まれません。
Parameters
名前 | 型 | 属性 | 説明 |
---|---|---|---|
argv | string | Array:.<string:> | <optional> | 解析する引数 |
戻り値
すべてから解析された引数
(static) loadPkgRc(argsopt) → {external:yargsParser.Arguments|void}
args.package
にpackage.json
へのパスが指定されている場合、mocha
プロパティから設定を読み込もうとします。
Parameters
名前 | 型 | 属性 | 説明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
args | オブジェクト | <optional> | 引数オブジェクト プロパティ
|
戻り値
解析された設定、またはargs.package
がfalse
の場合は何もなし
- 型
- external:yargsParser.Arguments | void
(static) loadRc(argsopt) → {external:yargsParser.Arguments|void}
args.config
に設定ファイルへのパスが指定されている場合、設定ファイルを読み込んで解析しようとします。
Parameters
名前 | 型 | 属性 | 説明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
args | オブジェクト | <optional> | 引数オブジェクト プロパティ
|
戻り値
解析された設定、またはargs.config
がfalse
の場合は何もなし
- 型
- external:yargsParser.Arguments | void
(static) lookupFiles(filepath, extensionsopt, recursiveopt) → {Array:.<string:>}
ファイル名は、OS/ファイルシステムによって*トラバーサル*順で返されます。
名前が特定の方法でソートされるとは想定しないでください。
Parameters
名前 | 型 | 属性 | デフォルト | 説明 |
---|---|---|---|---|
filepath | string | 検索を開始する基本パス。 | ||
extensions | Array:.<string:> | <optional> | [] | 検索するファイル拡張子。 |
recursive | boolean | <optional> | false | サブディレクトリに再帰的にアクセスするかどうか。 |
スロー
パターンに一致するファイルがない場合。
- 型
- Error
filepath
がディレクトリであり、extensions
が指定されていない場合。- 型
- TypeError
戻り値
パスの配列。
(static) main(argv, mochaArgsopt)
Mochaのメインコマンドラインエントリポイント。
- ソース
- 引数の
Array
を受け入れます。 - コンシューマモジュールの簡単な読み込みのために、Node.jsの検索パスを変更します。
- Error.stackTraceLimitを
Infinity
に設定します。
Parameters
名前 | 型 | 属性 | 説明 |
---|---|---|---|
argv | Array:.<string:> | 解析する引数の配列、またはデフォルトでは素晴らしい | |
mochaArgs | object | <optional> | 既に解析されたMocha引数のオブジェクト(bin/mochaによる) |