lib/cli

Node.jsでのプログラムによる使用のためのCLIエントリポイントと公開APIを含みます。

  • オプションの解析はyargsによって処理されます。
  • nodeを介して実行された場合、このモジュールはmain()を実行します。
ソース

メソッド

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

.mocharc.*package.jsonから読み取ったオプションを解析します。

ソース

優先順位リスト

  1. コマンドライン引数
  2. RCファイル(.mocharc.c?js.mocharc.ya?mlmocharc.json
  3. package.jsonmochaプロパティ
  4. デフォルト設定(lib/mocharc.json

「ワンアンドオン」オプションがargv配列に存在する場合、外部の設定ファイルは読み込まれません。

Parameters
名前属性説明
argvstring | Array:.<string:><optional>

解析する引数

戻り値

すべてから解析された引数

external:yargsParser.Arguments

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

ソース

args.packagepackage.jsonへのパスが指定されている場合、mochaプロパティから設定を読み込もうとします。

Parameters
名前属性説明
argsオブジェクト<optional>

引数オブジェクト

プロパティ
名前属性説明
configstring | boolean<optional>

package.jsonへのパス、またはスキップする場合はfalse

戻り値

解析された設定、またはargs.packagefalseの場合は何もなし

external:yargsParser.Arguments | void

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

ソース

args.configに設定ファイルへのパスが指定されている場合、設定ファイルを読み込んで解析しようとします。

Parameters
名前属性説明
argsオブジェクト<optional>

引数オブジェクト

プロパティ
名前属性説明
configstring | boolean<optional>

設定ファイルへのパス、またはスキップする場合はfalse

戻り値

解析された設定、またはargs.configfalseの場合は何もなし

external:yargsParser.Arguments | void

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

ソース

ファイル名は、OS/ファイルシステムによって*トラバーサル*順で返されます。
名前が特定の方法でソートされるとは想定しないでください。

Parameters
名前属性デフォルト説明
filepathstring

検索を開始する基本パス。

extensionsArray:.<string:><optional>
[]

検索するファイル拡張子。

recursiveboolean<optional>
false

サブディレクトリに再帰的にアクセスするかどうか。

スロー
  • パターンに一致するファイルがない場合。

    Error
  • filepathがディレクトリであり、extensionsが指定されていない場合。

    TypeError
戻り値

パスの配列。

Array:.<string:>

(static) main(argv, mochaArgsopt)

Mochaのメインコマンドラインエントリポイント。

ソース
Parameters
名前属性説明
argvArray:.<string:>

解析する引数の配列、またはデフォルトでは素晴らしいprocess.argv.slice(2)

mochaArgsobject<optional>

既に解析されたMocha引数のオブジェクト(bin/mochaによる)