External module utils/mocha

Helpers to run Mocha.

Index

Interfaces

Variables

MOCHA_BIN

Functions

Variables

Const MOCHA_BIN

MOCHA_BIN: Furi = new Furi(fromSysPath(require.resolve("mocha/bin/mocha")))

Absolute path to the Mocha CLI script.

Functions

execMocha

execMocha(args?: string[], experimentalModules?: boolean, options?: SpawnOptions): Promise<SpawnResult>

- Defined in src/lib/utils/mocha.ts:28
Runs the Mocha CLI with the provided arguments.

Parameters
- Default value args: string[] = []
  
  Array of CLI arguments.
- Default value experimentalModules: boolean = false
  
  Use --experimental-modules.
- Optional options: SpawnOptions
  
  Extra options for the spawned process.
Returns Promise<SpawnResult>

Promise for the execution result.

getCommand

getCommand(options: GetCommandArgsOptions): string[]

- Defined in src/lib/utils/mocha.ts:83
Returns the command line arguments equivalent to this task

Parameters
- options: GetCommandArgsOptions
  
  Mocha options
Returns string[]

Command line arguments

getCommandArgs

getCommandArgs(options: GetCommandArgsOptions): string[]

- Defined in src/lib/utils/mocha.ts:123
Builds command line arguments for Mocha.

Parameters
- options: GetCommandArgsOptions
  
  Controls the generated arguments.
Returns string[]

The corresponding list of command line arguments.

getSources

getSources(baseDir: Furi, specPattern: string): Sources

- Defined in src/lib/utils/mocha.ts:68
Resolve locations of the Mocha spec files.

Parameters
- baseDir: Furi
  
  Base directory to resolve the patterns.
- specPattern: string
  
  Minimatch pattern for the spec files.
Returns Sources

Resolved locations.

run

run(options: RunOptions): Promise<void>

- Defined in src/lib/utils/mocha.ts:183
Runs Mocha BDD tests with the provided options.

Parameters
- options: RunOptions
Returns Promise<void>

Promise resolved once the tests end. If Mocha ends with a non-zero exit code, the promise is rejected with the TestError error.

Generated using TypeDoc